All pages

API reference

List webhook receivers

GET /v1/webhooks

View as Markdown

The receivers in the projects this key reaches, on its own side of test mode: a test key lists test receivers. Needs webhooks:read.

Parameters

Name In Type Required Description
project_id query string (uuid) or null No Only this project's.

Answer

200 with WebhookReceiverList.

Errors

Every error is a problem document with a stable code.

Status When
401 The key is missing, mistyped, unknown, revoked or expired.
403 The key lacks a permission, a live key was sent from a browser, or the organization is frozen and the request would change something.
422 Validation Error
429 Too many requests for this key or its organization; see Retry-After.
500 Something went wrong on our side. Quote the request_id to support.

Examples

List webhook receivers
#!/bin/sh
# List webhook receivers
curl -sS --fail-with-body -X GET "https://api.aigently.ai/v1/webhooks" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.