Core ResourcesEvent Subscriptions

Update an Event Subscription

Update an event subscription with the given ID.

Path parameters

idstringRequired

The unique identifier for the event subscription

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
statusenumOptional

The status of the event subscription:

  • active: The event subscription is active and events will be delivered
  • disabled: The event subscription is temporarily disabled and events will not be delivered
  • deleted: The event subscription is permanently deleted and events will not be delivered
Allowed values:

Response

Updated

urlstring

The webhook url where we’ll send notifications.

idstringOptional

The unique identifier for the event subscription

created_atdatetimeOptional

The date and time the event subscription was created

statusenumOptional

The status of the event subscription. This indicates if we’ll send notifications to this subscription

  • active: subscription is active and events will be delivered normally
  • disabled: subscription is temporarily disabled and events will not be delivered
  • deleted: subscription has been deleted and events will not be delivered
  • requires_attention: subscription has been disabled due to delivery failures and events will not be delivered
Allowed values:
categoryenumOptional

The category of the event. This is useful for filtering events.

Allowed values:

Errors