HomeKnowledge BaseAPI Reference
API ReferenceSubmit a Ticket
API Reference
API ReferenceSubmit a Ticket

Add Webhook

post
https://api.campaignrefinery.com/rest/webhooks/add

Add webhook(s) to your ESP (Email Service Provider) to receive event notifications. If event_type is provided, adds a webhook for that specific event only. Otherwise, adds webhooks for every event supported by the domain's provider. The domain must belong to your account or, for billing group owners, to a sub-account in your billing group; unknown domains return 404.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The sending domain to configure webhooks for. Either domain or domain_id is required.

uuid

The domain UUID, as returned by /rest/eds/get_eds. Either domain or domain_id is required.

string
enum

The ESP provider of the domain. If not provided, it is detected from the domain's account.

Allowed:
string
enum

Specific event type to add a webhook for (Mailgun and SendGrid use lowercase event names, SES uses capitalized names). For SendGrid, all events share a single account-level webhook URL. If not provided, webhooks for all supported events will be added.

uri

The URL that will receive webhook notifications. If not provided, uses the default Campaign Refinery webhook URL.

Responses

Updated 3 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago