Developer tools

Outbound webhooks

Event types

Webhook event types

Learn more about the types of events that Knock sends webhook events for.

Message events

`message.sent`

Occurs when a message is successfully sent to a channel provider.

dataMessage

The associated message.

`message.delivered`

Occurs when a message is marked as delivered to the user by the provider. Not all channels support delivery tracking. Reference the docs on the delivered message status to see which channels and providers are supported.

dataMessage

The associated message.

`message.delivery_attempted`

Occurs when a message delivery attempt fails and may be retried.

dataMessage

The associated message.

event_dataEventData

Additional information about the attempt, the total attempts, and whether or not it will be retried.

EventData attributes:

attemptnumber

The current attempt count.

max_attemptsnumber

The total number of attempts that can be tried.

retryableboolean

Whether or not the current attempt is retryable.

`message.undelivered`

Occurs when a message delivery attempt fails permanently. Delivery will not be retried.

dataMessage

The associated message.

event_dataEventData

May include additional information about the failure.

EventData attributes:

failure_reasonstring

The reason for a message failure.

failure_detailsstring

Details about a message failure.

`message.bounced`

Occurs when a message delivery attempt fails due to bounce or a delivery status check results in a bounce because of a bad recipient(s) identifier. Delivery will not be retried.

dataMessage

The associated message.

event_dataEventData

May include additional information about the failure.

EventData attributes:

failure_reasonstring

The reason for a message failure.

failure_detailsstring

Details about a message bounce.

tokenstring

The erroneous token causing the bounce. Only applicable for push messages.

`message.seen`

Occurs when a message is seen by its recipient.

dataMessage

The associated message.

`message.unseen`

Occurs when a message is unseen by its recipient.

dataMessage

The associated message.

`message.read`

Occurs when a message is read by its recipient.

dataMessage

The associated message.

`message.unread`

Occurs when a message is unread by its recipient.

dataMessage

The associated message.

`message.archived`

Occurs when a message is archived by its recipient.

dataMessage

The associated message.

`message.unarchived`

Occurs when a message is unarchived by its recipient.

dataMessage

The associated message.

`message.interacted`

Occurs when a message is interacted with by its recipient. For the Knock in-app feed, this indicates that your recipient has explicitly clicked on the notification cell in their feed.

dataMessage

The associated message.

event_dataobject

Includes any additional metadata included in the interacted event.

`message.link_clicked`

Occurs when a link is clicked by the message recipient. This is only available when Knock link tracking is enabled.

dataMessage

The associated message.

event_dataEventData

May include additional information about the link click event.

EventData attributes:

urlstring

The target URL that was clicked.

Workflow events

`workflow.updated`

Occurs whenever a workflow is updated in the environment.

dataWorkflow

The associated workflow.

`workflow.committed`

Occurs whenever a workflow is committed to the environment.

dataWorkflow

The associated workflow.

event_dataEventData

Additional information about the commit.

EventData attributes:

commit_idstring

The ID of the corresponding commit for the event.

Email layout events

`email_layout.updated`

Occurs whenever an email layout is updated in the environment.

dataEmailLayout

The associated email layout.

`email_layout.committed`

Occurs whenever an email layout is committed to the environment.

dataEmailLayout

The associated email layout.

event_dataEventData

Additional information about the commit.

EventData attributes:

commit_idstring

The ID of the corresponding commit for the event.

Translation events

`translation.updated`

Occurs whenever a translation is updated in the environment.

dataTranslation

The associated translation.

`translation.committed`

Occurs whenever a translation is committed to the environment.

dataTranslation

The associated translation.

event_dataEventData

Additional information about the commit.

EventData attributes:

commit_idstring

The ID of the corresponding commit for the event.

Source event action events

`source_event_action.updated`

Occurs whenever a source event action is updated in the environment.

dataSourceEventAction

The associated source event action.

`source_event_action.committed`

Occurs whenever a source event action is committed to the environment.

dataSourceEventAction

The associated source event action.

event_dataEventData

Additional information about the commit.

EventData attributes:

commit_idstring

The ID of the corresponding commit for the event.

Partial events

`partial.updated`

Occurs whenever a partial is updated in the environment.

dataPartial

The associated partial.

`partial.committed`

Occurs whenever a partial is committed to the environment.

dataPartial

The associated partial.

event_dataEventData

Additional information about the commit.

EventData attributes:

commit_idstring

The ID of the corresponding commit for the event.