API Reference

Register a webhook destination URL for a given event type across a list of sites.

The following event types are supported: Supported Trigger Events.

To register a webhook you will need to POST the following JSON payload as part of your authenticated request in the following format.

{"notification_subscriptions": [
	{
		"target_url": "https://eod6fnuipucpv6h.m.pipedream.net",
    "site_ids": [42, 43],
		"event_types": ["alert.created", "alert.updated"],
		"type": "webhook"
	}
]}

Here is a summary of all the required fields that should be included within the nested object array notification_subscriptions.

FieldDescriptionExample
target_urlThe webhook destination URL"https://eod6fnuipucamsm.m.pipedream.net"
site_idsThe list of sites to trigger event types for the webhook[42, 43]
event_typesThe list of event types to trigger the webhook["alert.created", "alert.updated]
typeThe type of notification subscription. Must be entered as "webhook""webhook"
Language
Credentials
OAuth2
Authenticate
Click Try It! to start a request and see the response here!