webhooks

Update webhook

post/api/webhooks

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

authTokenstring

Auth token

authType'NoAuth' | 'Basic' | 'OAuth2'

The type of authentication Iterable uses when calling this webhook

blastSendEnabledboolean

Whether or not Iterable calls this webhook for blast campaigns

enabledboolean

Whether or not Iterable will call the webhook when sending campaigns

endpointstring

The URL associated with the webhook

idinteger required

The ID of the webhook in Iterable

triggeredSendEnabledboolean

Whether or not Iterable calls this webhook for triggered campaigns

Response

successful operation

authTypestring required

Auth type

blastSendEnabledboolean required

Blast Send Enabled

channelIdsobject[]

Channel IDs

enabledboolean required

Enabled

endpointstring required

Endpoint

idinteger required

Webhook ID

messageTypeIdsobject[]

Message Type IDs

triggeredSendEnabledboolean required

Triggered Send Enabled

Changes

No recorded changes to this operation across all 4 revisions of this API.