List Webhooks

View as MarkdownEdit this pageReport an issueSet up docs MCP

GET/api/v2/webhooks

Retrieves webhooks for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When more records exist than are returned, meta.total exceeds data.length; clients with large collections must page with limit/offset to retrieve them all.

Authorizations

AuthorizationBearer API Keyheaderrequired
`Authorization: Bearer <token>`

Query parameters

limitoptionalinteger
Maximum number of webhooks to return.

maximum: 1000, minimum: 1
Default: 1000
offsetoptionalinteger
Number of webhooks to skip before returning results.

minimum: 0
Default: 0

Response

JSON

200

Successfully retrieved webhooks

JSON

dataarray ofSlackWebhookorIncidentIOWebhookorGenericWebhookrequired
List of webhook objects.
3 variants
One of the following:
SlackWebhookslack
View SlackWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439011"
namestringrequired
Webhook name

Example: "Production Alerts"
serviceslackrequired
Webhook service type

Example: "slack"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
Slack incoming webhook URL

Example: "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Sends critical alerts to the #incidents channel"
IncidentIOWebhookincidentio
View IncidentIOWebhook schema →
7 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439012"
namestringrequired
Webhook name

Example: "Incident Response"
serviceincidentiorequired
Webhook service type

Example: "incidentio"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
incident.io alert event HTTP source URL

Example: "https://api.incident.io/v2/alert_events/http/abc123"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Routes alerts to incident.io for on-call escalation"
GenericWebhookgeneric
View GenericWebhook schema →
8 properties
idstringrequired
Webhook ID

Example: "507f1f77bcf86cd799439013"
namestringrequired
Webhook name

Example: "PagerDuty Integration"
servicegenericrequired
Webhook service type

Example: "generic"
updatedAtstringrequired
Last update timestamp

format: date-time
Example: "2025-06-15T10:30:00.000Z"
createdAtstringrequired
Creation timestamp

format: date-time
Example: "2025-01-01T00:00:00.000Z"
urloptionalstring
Webhook destination URL

Example: "https://example.com/webhooks/alerts"
descriptionoptionalstring
Webhook description, shown in the UI

Example: "Forwards alert payloads to an external monitoring service"
bodyoptionalstring
Optional request body template

Example: "{\"alert\": \"{{title}}\", \"severity\": \"{{level}}\"}"
metaobjectrequired
Pagination metadata for this result page.
3 properties
- totalintegerrequired
  Total number of items matching the query, ignoring pagination.
  
  Example: 142
- limitintegerrequired
  Maximum number of items returned in this page.
  
  Example: 50
- offsetintegerrequired
  Number of items skipped before this page.
  
  Example: 100

List Webhooks

curl --request GET \
  --url /api/v2/webhooks \
  --header 'Authorization: Bearer <token>'

const url = '/api/v2/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Production Alerts",
      "service": "slack",
      "url": "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX",
      "description": "Sends critical alerts to the #incidents channel",
      "updatedAt": "2025-06-15T10:30:00.000Z",
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 100
  }
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "NOT_FOUND: Alert not found"
}