Skip to navigation
Core ResourcesEvent Subscriptions

Update an Event Subscription

Update an event subscription with the given ID.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequired
The unique identifier for the event subscription

Request

The request body for creating an event subscription
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.
idstringOptionalRead-only
The unique identifier for the event subscription
created_atdatetimeOptionalRead-only
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

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error