Custom Webhook Integration Reference

A custom webhook has an ingest URL. Each accepted request creates a received event. Create and verify a custom webhook shows how to make one and send a test request.

Integration connection identity

You choose the integration connection slug. It must be unique in the workspace. Use it as source with the event name received.

This trigger fragment belongs under an existing workflow's triggers map:

triggers:
  on_webhook:
    source: deploy_hook # Replace with your webhook integration connection slug.
    event: received

Request contract

Send an HTTP POST request to the integration connection's ingest URL. The body can contain JSON, form data, or plain text.

You may send an X-Delivery-ID header. Shipfox uses it to detect a retried delivery. Shipfox creates an ID when the header is absent.

An accepted request returns 202 Accepted with its delivery_id.

Event payload

The run receives an event object with these values:

A trigger filter can read event.headers, event.query, and event.body. See Expressions for filter behavior.