Webhook event types

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

message.sent

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

dataMessageThe associated message

message.delivered

Occurs when a message is marked as delivered to the user by the provider. This is only available on email providers with delivery tracking enabled.

dataMessageThe associated message

message.delivery_attempted

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

dataMessageThe associated message
event_dataEventDataAdditional information about the attempt, the total attempts, and whether or not it will be retried

EventData attributes:

attemptnumberThe current attempt count
max_attemptsnumberThe total number of attempts that can be tried
retryablebooleanWhether or not the current attempt is retryable

message.undelivered

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

dataMessageThe associated message
event_dataEventDataMay include additional information about the failure

EventData attributes:

failure_reasonstringThe reason for a message failure
failure_detailsstringDetails 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.

dataMessageThe associated message
event_dataEventDataMay include additional information about the failure.

EventData attributes:

failure_reasonstringThe reason for a message failure
failure_detailsstringDetails about a message bounce
tokenstringThe erroneous token causing the bounce. Only applicable for push messages.

message.seen

Occurs when a message is seen by its recipient.

dataMessageThe associated message

message.unseen

Occurs when a message is unseen by its recipient.

dataMessageThe associated message

message.read

Occurs when a message is read by its recipient.

dataMessageThe associated message

message.unread

Occurs when a message is unread by its recipient.

dataMessageThe associated message

message.archived

Occurs when a message is archived by its recipient.

dataMessageThe associated message

message.unarchived

Occurs when a message is unarchived by its recipient.

dataMessageThe associated message

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

dataMessageThe associated message
event_dataEventDataMay include additional information about the link click event

EventData attributes:

link_clickedstringDetails about a link click event

workflow.updated

Occurs whenever a workflow is updated in the environment.

dataWorkflowThe associated workflow

workflow.committed

Occurs whenever a workflow is committed to the environment.

dataWorkflowThe associated workflow

email_layout.updated

Occurs whenever an email layout is updated in the environment.

dataEmailLayoutThe associated email layout

email_layout.committed

Occurs whenever an email layout is committed to the environment.

dataEmailLayoutThe associated email layout

translation.updated

Occurs whenever a translation is updated in the environment.

dataTranslationThe associated translation

translation.committed

Occurs whenever a translation is committed to the environment.

dataTranslationThe associated translation

source_event_action.updated

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

dataSourceEventActionThe associated source event action

source_event_action.committed

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

dataSourceEventActionThe associated source event action