Webhooks

Send a test event

Fire a sample event at the endpoint synchronously and return the receiver's response so you can debug your handler end-to-end. The probe is signed exactly like a real delivery (verify it the same way) but is not persisted to the delivery log. Configure the endpoint itself with Update a webhook endpoint. Requires the webhooks:manage capability.

post/webhooks/{id}/test

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/webhooks/{id}/test
  • Auth: HTTP bearer

Response

The probe result.

object'webhook_test' required
deliveredboolean required

Whether the endpoint accepted the probe (2xx).

response_statusinteger nullable required

The HTTP status the endpoint returned, or null on a transport error.

event_typestring required

The sample event type that was sent.

errorstring nullable required

A transport/error message when delivery failed, else null.

Changes

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