Webhooks

Create a Webhook Subscription

Subscribe an HTTPS endpoint of yours to event types. The endpoint must be https on port 443 at a public address. Name projects to receive only their events, or none to receive the events of every project of your organization you do not exclude. Name excluded projects to never receive their events, even a project you also name; an event that carries no project is not affected by them. Creating your organization's first subscription creates its signing key.

post/webhooks/subscriptions

Request

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

Request body

namestring required

A name for it.

urlstring required

The HTTPS endpoint to deliver to, on port 443, with no user name or password. Its host is a host name; an IP address or localhost is refused.

eventTypesstring[] required

The event types to receive, each one the API publishes.

projectIdsstring[]

The projects whose events to receive; omit or leave empty for the events of every project you do not exclude.

excludedProjectIdsstring[]

The projects whose events never to receive, even a project projectIds names; omit or leave empty to exclude none. An event that carries no project is not affected.

Response

The subscription, enabled.

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.