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

Remove Webhook

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

Remove webhook(s) from your ESP. If event_type is provided, removes the webhook for that specific event only. If target_url is provided, removes that URL from all event types. Otherwise, removes all webhooks except the protected Campaign Refinery system webhook. 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 remove webhooks from. 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 remove the webhook for (Mailgun and SendGrid use lowercase event names, SES uses capitalized names). For SendGrid, removing an event disables it on the shared account-level webhook.

uri

Specific URL to remove from webhooks. Cannot be the Campaign Refinery system 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