webhooks

Creates a webhook endpoint for the authenticated account and returns its signing secret in the response body.

post/api/webhooks

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
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

descriptionstring nullable

Free-text description of the endpoint.

eventsstring[] required

Events to subscribe to, for example "job.completed" or "job.failed". At least one is required.

urlstring required

HTTPS URL that receives event notifications (at most 2048 characters, no private or loopback address).

Response

Endpoint created; secret is shown once.

consecutive_failuresinteger required

Number of failed deliveries in a row since the last success.

created_atstring required

RFC 3339 creation timestamp.

descriptionstring nullable

Description of the endpoint, omitted when none was set.

eventsstring[] required

Events the endpoint is subscribed to.

last_delivery_atstring nullable

RFC 3339 timestamp of the last delivery, omitted when there was none.

statusstring required

Status of the endpoint: "active", "paused" or "disabled".

successful_deliveriesinteger required

Number of deliveries the endpoint acknowledged with a 2xx status.

total_deliveriesinteger required

Number of deliveries attempted.

urlstring required

URL that receives the notifications.

uuidstring required

Public UUID of the endpoint.

secretstring required

The signing secret, hex-encoded. It is returned only once, so store it securely.

Changes

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