A valid request URL is required to generate request examples{
"can_manage": true,
"available_scopes": [
"account"
],
"data": [
{
"id": "<string>",
"object": "webhook_endpoint",
"merchant_id": "<string>",
"scope": "account",
"livemode": true,
"url": "<string>",
"description": "<string>",
"event_types": [
"<string>"
],
"api_version": "<string>",
"status": "active",
"disabled": true,
"created_at": 123,
"updated_at": 123,
"secret_last_rotated_at": 123,
"deleted_at": 123
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_REQUEST",
"message": "url is required"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}List webhook endpoints
Returns endpoints registered in this mode, newest first. Signing
secrets are never included. Omit limit to receive the full list in
one response; pass limit (and starting_after from next_cursor)
to page.
A valid request URL is required to generate request examples{
"can_manage": true,
"available_scopes": [
"account"
],
"data": [
{
"id": "<string>",
"object": "webhook_endpoint",
"merchant_id": "<string>",
"scope": "account",
"livemode": true,
"url": "<string>",
"description": "<string>",
"event_types": [
"<string>"
],
"api_version": "<string>",
"status": "active",
"disabled": true,
"created_at": 123,
"updated_at": 123,
"secret_last_rotated_at": 123,
"deleted_at": 123
}
],
"has_more": true,
"next_cursor": "<string>"
}{
"error": {
"code": "INVALID_REQUEST",
"message": "url is required"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Query Parameters
Page size (1-100). Omit to receive the full list in one response.
1 <= x <= 100Cursor: an id from this list (typically the previous response's next_cursor). Returns results strictly after it, newest first.
Response
A list of webhook endpoints, newest first. Signing secrets are not included.
Whether this caller currently has write access to the selected webhook scope.
Webhook workspaces this caller can currently read. Dashboard sessions may select one using the scope query parameter.
account, connected_accounts The webhook endpoints on this page.
Show child attributes
Show child attributes
True when more records exist beyond this page.
Present when has_more is true: the last returned endpoint's id. Pass it as starting_after on the next request.