Skip to navigation
API ReferenceWebhooks

Get Webhooks

View as Markdown

All parameters are AND filters

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

TopicenumOptional
Topic of the webhooks requested
Allowed values:
PageintegerOptional0-2147483647
Page of Webhooks to get
LimitintegerOptional1-250
Amount of Webhooks per page to request

Response headers

Page-Numberinteger
Number of the current page
Total-Pagesinteger
Total number of pages of results
Total-Countinteger
Total number of results
Page-Sizeinteger
Number of results per page
Next-PagestringOptional
The href of the next page of results, if there is a next page

Response

Success
created_atdatetimeOptional
Timestamp the webhook subscription was created
enabledbooleanOptional
Indicates if the webhook subscription is enabled or not
idintegerOptional
ID of the webhook subscription
subscription_urlstring or nullOptionalformat: "uri"
URL subscription events will be posted to
topicenumOptional
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error