Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://api.bundleup.io/v1/webhooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "url": "<string>",
    "events": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "workspaceId": "<string>"
  }
]

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Query Parameters

offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 1000
limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100

Response

List of webhooks retrieved successfully

id
string
required

Unique webhook identifier

name
string
required

Webhook name

url
string<uri>
required

Webhook URL

events
object
required

Webhook events configuration

createdAt
string<date-time>

When the webhook was created

updatedAt
string<date-time>

When the webhook was last updated

workspaceId
string

ID of the workspace this webhook belongs to