webhooks

Updates the URL, subscribed events, description or status of a webhook endpoint.

patch/api/webhooks/{uuid}

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

Path parameters

uuidstring required

Public UUID of the webhook endpoint.

Request body

descriptionstring nullable

New description. Left unchanged when absent.

eventsstring[] nullable

New list of subscribed events, with at least one entry. Left unchanged when absent.

statusstring nullable

New status: "active" or "paused". Left unchanged when absent.

urlstring nullable

New HTTPS URL. Left unchanged when absent.

Response

The updated webhook endpoint.

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.

Changes

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