Webhooks

Fire a synthetic test event

Queues a synthetic envelope through the real dispatcher, so it exercises the same signing and delivery path as a live event. The endpoint must be active and not paused.

post/api/v1/customer/webhooks/{id}/test

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/customer/webhooks/{id}/test
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

idstring required

Response

Test event queued

successboolean
messagestring
delivery_idstring
event_idstring
event_typestring

Changes

No recorded changes to this operation across all 1 revision of this API.