ATattentive
Webhooks

Create webhook

Make an API call to this endpoint to subscribe to a webhook.

Events are a collection of strings of the following types:

  • sms.subscribed
  • sms.sent
  • sms.message_link_click
  • email.subscribed
  • email.unsubscribed
  • email.message_link_click
  • email.opened
  • custom_attribute.set

Event types are case sensitive.

All events included will be sent to the URL.

post/webhooks

Request

  • Base URL
    https://api.attentivemobile.com/v1
  • Auth
    OAuth 2
    Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
    Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: webhooks:write

Request body

urlstring

The destination url of the webhook

eventsstring[]

The list of events this webhook is subscribed to

Example request

{
  "url": "https://example.com/webhooks",
  "events": [
    "sms.sent",
    "phone.subscribed"
  ]
}

Response

Webhook has been created

idstring

The id of the installed webhook

urlstring

The destination url of the webhook

eventsstring[]

The list of events this webhook is subscribed to

typestring

The type of webhook; can be either INSTALLED or CREATOR

disabledAtstring

(optional) Date (YYYY-MM-DD hh:mm:ss) of when the webhook was deleted if it was deleted

Example response

{
  "id": "MjU6Q29tcGFueUFwcGxpY2F0aW9uV2ViaG9vazIy",
  "url": "https://example.com/webhooks",
  "events": [
    "sms.sent",
    "phone.subscribed"
  ]
}

Changes

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