Webhooks

Send a test event

Queues a signed sample event (test: true) to the endpoint and returns the delivery id; follow it with GET /v1/webhook-deliveries/{id}. Every event type can be tested; the sample data has the real event's shape, including data.event for email.delivered, email.bounced and email.complained. Ids are made up and files have no URL.

post/v1/webhook-endpoints/{endpoint_id}/test

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/webhook-endpoints/{endpoint_id}/test
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

endpoint_idstring required

Webhook endpoint id (whe_…).

Headers

Idempotency-Keystring

Replays the stored response for 24 h; a different body with the same key → 422.

Request body

event'render.succeeded' | 'render.failed' | 'render.expired' | 'batch.progress' | 'batch.completed' | 'storage.upload_failed' | 'email.sent' | 'email.send_failed' | 'email.delivered' | 'email.bounced' | 'email.complained' | 'usage.threshold_reached' | 'template.published' | 'api_key.expiring'
  • render.succeeded - render.succeeded
  • render.failed - render.failed
  • render.expired - render.expired
  • batch.progress - batch.progress
  • batch.completed - batch.completed
  • storage.upload_failed - storage.upload_failed
  • email.sent - email.sent
  • email.send_failed - email.send_failed
  • email.delivered - email.delivered
  • email.bounced - email.bounced
  • email.complained - email.complained
  • usage.threshold_reached - usage.threshold_reached
  • template.published - template.published
  • api_key.expiring - api_key.expiring

Response

Queued.

delivery_idstring required

Follow it with GET /v1/webhook-deliveries/{id}.

objectstring

Changes

No recorded changes to this operation across all 2 revisions of this API.