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.
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.
message.delivery_attempted
#Occurs when a message delivery attempt fails and may be retried.
EventData
attributes:
message.undelivered
#Occurs when a message delivery attempt fails permanently. Delivery will not be retried.
EventData
attributes:
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.
EventData
attributes:
message.seen
#Occurs when a message is seen by its recipient.
message.unseen
#Occurs when a message is unseen by its recipient.
message.read
#Occurs when a message is read by its recipient.
message.unread
#Occurs when a message is unread by its recipient.
message.archived
#Occurs when a message is archived by its recipient.
message.unarchived
#Occurs when a message is unarchived by its recipient.
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.
message.link_clicked
#Occurs when a link is clicked by the message recipient. This is only available when Knock link tracking is enabled.
EventData
attributes:
Workflow events#
workflow.updated
#Occurs whenever a workflow is updated in the environment.
workflow.committed
#Occurs whenever a workflow is committed to the environment.
EventData
attributes:
Email layout events#
email_layout.updated
#Occurs whenever an email layout is updated in the environment.
email_layout.committed
#Occurs whenever an email layout is committed to the environment.
EventData
attributes:
Translation events#
translation.updated
#Occurs whenever a translation is updated in the environment.
translation.committed
#Occurs whenever a translation is committed to the environment.
EventData
attributes:
Source event action events#
source_event_action.updated
#Occurs whenever a source event action is updated in the environment.
source_event_action.committed
#Occurs whenever a source event action is committed to the environment.
EventData
attributes:
Partial events#
partial.updated
#Occurs whenever a partial is updated in the environment.
partial.committed
#Occurs whenever a partial is committed to the environment.
EventData
attributes: