webhook-subscriptions

Fetch webhook subscription

Returns a webhook subscription by its identifier.

get/api/v1/webhook-subscriptions/{id}

Path parameters

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Webhook subscription identifier (UUID).

Response

Webhook subscription found.

status'ACTIVE' | 'DISABLED_BY_FAILURES' | 'DISABLED_BY_USER' required
headersobject nullable required
metadataobject nullable required
idstring required
namestring required
urlstring required
event_typesstring[] required
disabled_atstring nullable required
created_atstring required
updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.8

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property disabled_at to the response with the 200 status

      response-required-property-added

    • added the required property event_types to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property updated_at to the response with the 200 status

      response-required-property-added

    • added the required property url to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog