Webhooks

Create a webhook endpoint

Register an https URL to receive event notifications (deliveries, bounces, opens, clicks, and more) and choose which events it subscribes to. The response includes the signing_secret exactly once — store it now, as it can never be retrieved again; use it to verify each delivery's signature. Confirm the endpoint works with Send a test event, and adjust its URL or events later with Update a webhook endpoint. Requires the webhooks:manage capability.

post/webhooks

Request

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

Request body

urlstring required
eventsstring[] required
namestring

Response

Created — includes the one-time signing secret.

object'webhook' required
idstring required
namestring required
urlstring required
eventsstring[] required
status'enabled' | 'disabled' | 'suspended' required
created_atstring required
updated_atstring required
signing_secretstring required

The HMAC signing secret. Shown exactly once — store it now; it can never be retrieved again. Use it to verify the signature on every delivery to this endpoint.

Changes

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