Webhooks

Update a Webhook Subscription

Change a subscription's name, endpoint, event types or projects. A changed endpoint is held to the rules creating one is. Disable and enable a subscription with their own operations.

patch/webhooks/subscriptions/{subscriptionId}

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/webhooks/subscriptions/{subscriptionId}
  • Auth: HTTP bearer

Request body

namestring

A new name.

urlstring

A new endpoint, held to the rules a created one is.

eventTypesstring[]

The event types to receive instead.

projectIdsstring[]

The projects whose events to receive instead, replacing the list; empty for the events of every project it does not exclude.

excludedProjectIdsstring[]

The projects whose events never to receive instead, even a project projectIds names, replacing the list; empty to exclude none. An event that carries no project is not affected.

Response

The subscription, changed.

idstring uuid required

The subscription's id.

namestring required

The name you gave it.

organizationIdstring uuid required

The organization it belongs to, the one whose credential created it.

projectIdsstring[] required

The projects whose events it receives; empty for the events of every project of the organization it does not exclude.

excludedProjectIdsstring[] required

The projects whose events it never receives, even a project projectIds names; empty for none. An event that carries no project is not affected.

urlstring required

The endpoint deliveries are sent to, as you wrote it.

eventTypesstring[] required

The event types it receives.

enabledboolean required

Whether deliveries are made to it; false once you or delivery disabled it.

createdAtstring date-time required

When it was created.

updatedAtstring date-time required

When a client last changed it.

lastAttemptAtstring date-time nullable required

When delivery last attempted to send to its endpoint, whatever the outcome; null before the first attempt.

Changes

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