webhooks

Sends a signed test delivery to a webhook endpoint.

post/api/webhooks/{uuid}/test

Request

  • Base URL: https://api.pricklymails.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pricklymails.com/api/webhooks/{uuid}/test
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

uuidstring required

Public UUID of the webhook endpoint.

Response

The test-fire outcome.

deliveredboolean required

true when the endpoint answered with a 2xx status.

errorstring nullable

A transport error message, or a description of the non-2xx status, None on success.

status_codeinteger nullable

The HTTP status the endpoint returned, None on a transport-level failure.

Changes

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