Email notifications for the Event Subscription API

As part of using the Event Subscription API, you will receive email notifications sent by the service. Some of these notifications are for information purposes only, such as confirming that a new subscription has been created or informing you when a subscription has been paused. However, some of these notifications are crucial alerts such as your subscription has failed and others may require you to perform specific actions in order to keep your subscriptions active and functional. Depending on the type of notification, these actions may range from increasing your daily event limit to manually extracting unsent event data.

Currently, the following event notifications may be received and should be reviewed for any potential actions required:

See the sections below for more specific details on each notification.

Active Subscription

Received to notify you that your subscription to a specific trigger is once again active and will begin forwarding new emitted events.

Triggering event:

  • Paused or suspended subscription is now active

Required actions:

  • None

Optional actions:

Deleted Subscription

Sent to confirm that a subscription to a specific trigger has been deleted and will no longer be sending events.

Triggering event:

  • Subscription is deleted

Required actions:

  • None

Optional actions:

  • None

Failed Subscription

Notification that one of your current subscriptions has started to fail and cannot send your event data. Any events that are unable to be sent to you will be saved in the system, so no data will be lost.

Triggering event:

  • Subscription begins to fail

Required actions:

  • Subscription must be updated or deleted within 8 hours or it will be suspended.

Optional actions:

New Subscription

Confirmation message that a new subscription was successfully created. These notifications also include basic information about the new subscription, such as the Subscription ID, Subscription Name, Protocol and Callback URL.

Triggering event:

  • New subscription is created

Required actions:

  • None

Optional actions:

  • None

Paused Subscription

Notification that one of your active subscriptions has been paused and will not forward events to you until the subscription is resumed. Any events that are unable to be sent to you will be saved in the system, so no data will be lost.

Triggering event:

  • Subscription to a trigger has been paused

Required actions:

  • None

Optional actions:

  • Resume the subscription to begin receiving event data again

Resumed Subscription

Indicates that a previously paused subscription has been resumed and will begin forwarding new events to you. Any unsent events that were saved while the subscription was paused will also be forwarded once the subscription is resumed.

Triggering event:

  • Paused subscriptions are resumed

Required actions:

  • None - for informative purposes only

Optional actions:

  • None

Rejected Subscription

Notification that your subscription was rejected because the system has been unable to deliver events to your webhook. Any events that are unable to be sent to you will be saved in the system, so no data will be lost.

Received when:

  • Subscription unable to deliver events to webhook

Required actions:

  • Check your webhook endpoint to ensure the webhook URL is correctly configured.
  • Once fixed, manually update your subscription to reactivate.

Optional actions:

  • Retrieve unsent events using the following URL:

    PATCH /intelligence/api/subscriptions/${subscriptionId}/events

Suspended Subscription

Message sent when an active subscription has continuously failed and will be suspended. Includes the specific date on which the subscription began to fail. Any pending data will be lost as a result of the subscription being suspended.

Triggering event:

  • Subscription has continued to fail

Required actions:

  • Subscription must be updated or deleted to resume sending data.

Optional actions:

  • None

Too Many Subscriptions

Warning message sent when you reach the maximum number of allowed subscriptions to knowledge model triggers. Reaching this limit will not impact any active subscriptions. However, it will prevent you from creating any new subscription.

Triggering event:

  • Subscription limit reached

Required actions:

  • None

Optional actions:

  • Delete unneeded subscriptions
  • Contact your account executive to increase your limit