Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knock Outbound Webhooks

Outbound webhooks fire message lifecycle (sent, delivered, seen, read, interacted, archived, link_clicked, bounced, undelivered) and environment-change (workflow / email_layout / translation / partial / source_event_action updates and commits) events as JSON POSTs to subscriber URLs configured in the Knock dashboard.

Knock Outbound Webhooks is one of 35 APIs that Knock publishes on the APIs.io network, described by an AsyncAPI event-driven specification.

Tagged areas include Webhooks, Events, and AsyncAPI. The published artifact set on APIs.io includes API documentation and an AsyncAPI specification.

This event API exposes 6 operations across 6 channels, and defines 30 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.

The API connects through a single server, https://api.knock.app (https).

6 operations 6 channels 30 schemas

Metadata

The identity and technical contract details declared by the specification.

Specification
AsyncAPI 2.6.0
API Version
1.0.0
Server
https://api.knock.app (https)
Contact
Resource Areas
1

Channels & Operations 6

Across 6 channels, the API surfaces 6 operations. Each is listed below with its action, channel, parameters, and response codes.

Channels 6
SUB
webhooks/messages
Message lifecycle events for one of the configured outbound webhook endpoints.
receiveMessageEvent body
SUB
webhooks/workflows
Workflow update + commit events.
receiveWorkflowEvent body
SUB
webhooks/email_layouts
receiveEmailLayoutEvent body
SUB
webhooks/translations
receiveTranslationEvent body
SUB
webhooks/partials
receivePartialEvent body
SUB
webhooks/source_event_actions
receiveSourceEventActionEvent body

Messages & Schemas 30

The contract defines 30 schemas that model the data carried by its messages. The most detailed are MessageEnvelope (4 properties), EnvObjectEnvelope (3 properties). Each schema is shown below with its type and property counts.

MessageSent
message
MessageDelivered
message
MessageDeliveryAttempted
message
MessageUndelivered
message
MessageBounced
message
MessageSeen
message
MessageUnseen
message
MessageRead
message
MessageUnread
message
MessageArchived
message
MessageUnarchived
message
MessageInteracted
message
MessageLinkClicked
message
WorkflowUpdated
message
WorkflowCommitted
message
EmailLayoutUpdated
message
EmailLayoutCommitted
message
TranslationUpdated
message
TranslationCommitted
message
PartialUpdated
message
PartialCommitted
message
SourceEventActionUpdated
message
SourceEventActionCommitted
message
MessageEnvelope
object
4 properties
MessageDeliveryAttemptedEnvelope
object
MessageFailureEnvelope
object
MessageBounceEnvelope
object
MessageLinkClickedEnvelope
object
EnvObjectEnvelope
object
3 properties
CommitEnvelope
object

Specification

The full machine-readable AsyncAPI contract behind this narrative.

Source

knock-webhooks-asyncapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Accounts API
Knock API keys API
Knock Audiences API
Knock Branches API
Knock Broadcasts API
Knock Bulk operations API
Knock Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts API
Knock Environments API