Webhooks

Send a synthetic test event

Changed on

Publishes a synthetic sendmux.test event to this webhook subscription. The subscription must include "sendmux.test" in event_types, and mailbox filters do not block the test delivery. Returns the generated event_id so you can correlate the X-Sendmux-Event-Id header on your endpoint.

Supply an Idempotency-Key header to safely retry on network errors — replays under the same key return the original event_id rather than publishing a second test event.

post/webhooks/{public_id}/test

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/webhooks/{public_id}/test
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: webhook.manage)

Path parameters

public_idstring required

Webhook public ID

Headers

Idempotency-Keystring

Client-chosen unique key to safely retry the request. Cached for 24h per (team, endpoint, key). Different target public_id under the same key returns 409 idempotency_conflict.

Example:webhooks-test-20260424-001

Response

Test event published

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "event_id": "evt_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}

Changes