Workspace

Test webhook

Send a signed ping event to the endpoint and return the delivery result.

post/orgs/webhooks/{webhook_id}/test

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/webhooks/{webhook_id}/test
  • Auth: HTTP bearer

Path parameters

webhook_idstring required

The ID of the webhook endpoint

Response

idstring required
webhook_idstring required
event'ping' | 'chat.assigned' | 'contact.blocked' | 'contact.unsubscribed' | 'broadcast.failed' | 'broadcast.bounced' | 'broadcast.complained' | 'broadcast.suppressed' required

An event a delivery can carry

event_idstring required
status'PENDING' | 'DELIVERED' | 'FAILED' | 'SKIPPED' required
attemptnumber required
next_attempt_atstring date-time nullable required
response_statusnumber nullable required
response_bodystring nullable required
errorstring nullable required
duration_msnumber nullable required
delivered_atstring date-time nullable required
created_atstring date-time nullable required

Changes

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