Sign in
webhook-subscriptions

Update webhook subscription

Partially updates a webhook subscription by its identifier.

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

Path parameters

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

Webhook subscription identifier (UUID).

Request body

event_typesstring[]
headersobject nullable
metadataobject nullable
namestring
urlstring uri
activeboolean

Response

Webhook subscription updated.

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.111

  • a3b4750a505f110See the full diff
    • ▲

      the event_types request property's minItems was increased to 1

      request-property-min-items-increased

    • ○

      added the new optional request property active

      new-optional-request-property

    • ○

      added the new optional request property name

      new-optional-request-property

    • ○

      added the new optional request property url

      new-optional-request-property

    • ○

      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

  • 84194c31ab851See the full diff
    • ○

      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