unPLUGDevelopers
/

Webhook endpoints API

List webhook endpoints

GET/v1/webhook_endpoints

Returns the endpoints in this environment, newest first. Secrets are never included.

Permissions: Secret key with webhooks:manage.

Guide

Webhooks

Query parameters#

  • limitinteger
    1 to 100. Default 25.
    Min 1Max 100Default 25
  • cursorstring
    next_cursor from the previous page. See Pagination.

Response fields#

Returns 200 with list of WebhookEndpoint

  • dataarray of WebhookEndpoint
    Show attributesWebhookEndpoint
    • idstring (uuid)
      The endpoint's id.
    • urlstring (uri)
      Where events are sent. HTTPS on a public hostname.
    • descriptionstringNullable
      Your label, up to 255 characters.
      Max Length 255
    • event_typesarray of string
      Types this endpoint gets, or ["*"] for all types, including types added later. See Webhook event types.
    • statusstring
      enabled or disabled. unPLUG sets disabled after 3 days of failed deliveries.
      One of enabled, disabled
    • secretstring
      The signing secret, whsec_ followed by base64. Returned only when you create the endpoint or rotate the secret.
    • created_atstring (date-time)
      When the endpoint was created.
    • updated_atstring (date-time)
      When the endpoint last changed.
  • has_moreboolean
    True when another page exists.
  • next_cursorstringNullable
    Pass as cursor to get the next page.