GeneralWebhook subscriptions

Update a webhook subscription

You can update the webhook listener URL or the event list.

Path parameters

webhook_subscription_idstringRequired

ID of the webhook subscription. This is the same value as the webhook_subscription_id you receive in webhooks.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

Request

This endpoint expects an object.
event_typeslist of stringsOptional

A list of events to subscribe to. If set to an empty array, the subscription includes all events triggered by the specified object_type.

object_typeenumOptional

The object type to whose events you want to subscribe.

To subscribe to events from multiple object types, create a separate subscription for each object type.

urlstringOptionalformat: "uri">=1 character<=2083 characters

An HTTPS URL to which Monite will send webhooks. This URL must be accessible over the public Internet, accept POST requests, and respond with status code 200. It must be a direct URL (no redirects).

The same URL can be used by multiple webhook subscriptions.

Response

Successful Response
idstringformat: "uuid"

A unique URL assigned to this webhook subscription. This ID is also included in the webhook data as the webhook_subscription_id field.

event_typeslist of strings

Events included in this webhook subscription. An empty array means the subscription includes all events triggered by the specified object_type.

object_typeenum
The object type associated with this webhook subscription.
statusenum
Allowed values:
urlstringformat: "uri">=1 character<=2083 characters
URL to which the webhooks are sent. The same URL can be used by multiple webhook subscriptions.

Errors