Skip to main content

Sequence Inbound Webhook

First create or update the sequence with trigger: "inbound_webhook" and an eventName. Then configure its secret endpoint:
  • GET /api/v1/sequences/{sequenceId}/inbound-webhook returns its URL, mapping, sample payload, and setup status.
  • PUT /api/v1/sequences/{sequenceId}/inbound-webhook creates or updates the endpoint.
  • POST /api/v1/sequences/{sequenceId}/inbound-webhook/rotate-secret replaces the secret and immediately invalidates the previous URL.
On first setup, omitted PUT fields apply the defaults from the sequence’s selected catalog or custom integration. On later calls, omitted fields keep their saved values, so a captured sample payload survives a mapping-only update. A custom mapping requires an email path and can optionally map names and event properties.
Set fieldMapping or samplePayload to null to clear it. The endpoint is active once it has a mapping; otherwise it remains pending_setup. The CLI exposes these operations as sequenzy sequences webhook get, configure, and rotate. MCP clients can use get_sequence_inbound_webhook, configure_sequence_inbound_webhook, and rotate_sequence_inbound_webhook_secret.