unPLUGDevelopers

Webhook endpoints API

Redeliver an event

POST/v1/events/{id}/redeliver

Sends an event again, with the same webhook-id and body and a fresh timestamp and signature. By default it goes to every enabled endpoint subscribed to the event's type; pass webhook_endpoint_id to send to one. A redelivery is a single attempt with no automatic retries. If it fails, redeliver again.

Permissions: Secret key with webhooks:manage.

Request headers#

  • Idempotency-Keystring
    Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
    Max Length 255

Path parameters#

  • idstring (uuid)Required

Request body#

  • webhook_endpoint_idstring (uuid)
    Send to this endpoint only. It must be enabled and subscribed to the event's type.

Response fields#

Returns 202 with list of Delivery

  • dataarray of Delivery
    Show attributesDelivery
    • idstring (uuid)
      The delivery attempt's id.
    • event_idstring (uuid)
      The event that was sent.
    • webhook_endpoint_idstring (uuid)
      Where it was sent.
    • attemptinteger
      1 for the first attempt, then counting up through the retries.
      Min 1
    • statusstring
      pending, succeeded or failed.
      One of pending, succeeded, failed
    • status_codeintegerNullable
      HTTP status your server returned. Null if there was no response.
    • response_msintegerNullable
      How long your server took to respond, in milliseconds.
    • errorstringNullable
      Why it failed when there was no HTTP status, for example timeout, connection_refused, tls_error or dns_error.
    • attempted_atstring (date-time)Nullable
      When the attempt was made.
    • next_retry_atstring (date-time)Nullable
      When the next retry is scheduled. Null after a success or when retries have run out.
  • has_moreboolean
    True when another page exists.
  • next_cursorstringNullable
    Pass as cursor to get the next page.

Error descriptions#

404Not found
not_found

No such event or endpoint, or the event is older than 30 days.

400Bad request
invalid_request

The endpoint isn't subscribed to this event type.

409Conflict
invalid_state

The endpoint is disabled. Turn it back on first.

Any endpoint can also return the common errors.