文档Engagement Platform API
Sign inGet started
Guides
API

List webhook subscriptions

GET
/workspaces/{workspaceId}/webhook-subscriptions
This endpoint allows you to list all webhook subscriptions for a workspace. You can filter the subscriptions by interactionType, status, and other filters. This will return a maximum of 100 webhook subscriptions per page, but 10 as default. You can use the limit and cursor query parameters to paginate the results. Learn more about pagination in the Common API Usage pagination section.
查询参数
SearchFilters
object
You can use this parameter to filter the results based on the search criteria. To get all subscriptions for the service channels, you can use it like this: SearchFilter[service]=channels
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
响应载荷
results
array of object
显示子属性
results.id
string
必填
The unique identifier for the webhook subscription. This identifier is used to reference the webhook subscription in other API calls.
results.organizationId
string
必填
results.workspaceId
string
必填
results.service
string
必填
The service that the webhook is subscribed to. For example, to get events regarding channels, the service would be channels.
Possible values: channels, numbers, payments, conversations, templates
results.event
string
必填
The event name identifies the webhook event, such as sms.outbound for notifications about SMS messages being sent.
results.eventFilters
array of object
显示子属性
results.eventFilters.key
string
必填
Possible values: channelId, platformId, channelStatus, interactionType, messageStatus, status, eventDestination, navigatorId
results.eventFilters.value
string
必填
results.template
string
Used for our Exit APIs for Twilio and Sinch. More information can be found here for Twilio and here for Sinch.
results.url
string
必填
The URL of the webhook is used to send events to the webhook. The URL must be a valid URL that respects the established pattern and is accessible from the internet.
results.signingKey
string
The signing key for the webhook and can be used to verify the authenticity of the webhook.
results.oauth2
object
OAuth 2.0 client credentials configuration.
显示子属性
results.oauth2.tokenUrl
string
必填
The OAuth 2.0 token endpoint where access tokens are requested.
results.oauth2.clientId
string
必填
The OAuth 2.0 client identifier.
results.oauth2.scopes
array of string
OAuth 2.0 scopes to request.
results.status
string
必填
Possible values: active, inactive
results.statusReason
string
A human-readable explanation for the current status of the webhook subscription.
results.createdAt
string
results.updatedAt
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
代码示例
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/webhook-subscriptions' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Examples

Let's establish some of our data that will be used in the following example:
  • Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352
  • AccessKey: abcd
代码示例
curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/webhook-subscriptions" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd"
Note: if you have more than 10 webhook subscriptions, the results may be paginated. To know more about how to use the nextPageToken to get the following results, refer to this pagination documentation.