Connect webhooks

Use webhooks when your service needs to react to activity in your projects: a customer submits, edits, or deletes an opinion, answers a question, comments on an opinion, verifies a purchase, or subscribes, or your team changes a project, question, or QR code. Topics are named <resource>.<past_tense_verb>, such as opinion.created, answer.created, or verification.verified. See Webhook operations for every topic and its payload.

Create a destination

Choose the URL and topics

Call webhooks.destinations.upsert with an HTTPS URL and the topics your receiver handles. Save the returned destination ID if you plan to update it.

Send only the topics your service processes. Every event is scoped to projects in your organization, and verification events omit receipt images and extracted evidence.

Update a destination

Reuse the destination ID

Send the existing destinationId with the replacement URL or topic list. Use the same operation for creation and updates.

Open the portal

Choose an operator theme

Call webhooks.portal when you need a Hookdeck Outpost portal link. Pass theme as light or dark when your operator interface needs a specific appearance.

Receiver checklist

1. Verify the request signature or delivery metadata required by your receiver setup.
2. Route on the body's type, and ignore topics your receiver does not handle.
3. Parse data without assuming optional fields are present.
4. Return a successful response after durable processing or queueing.
5. Make processing idempotent on the body's id, which is the same on every retry.
6. Log the event ID and response status without logging the API key.

See Troubleshooting when a destination does not receive events.