list alert webhooks.md

List Alert Webhooks

List Webhooks

Retrieve a list of all webhook configurations registered for your customer. This endpoint returns the webhook IDs, URLs, creation timestamps, and descriptions, allowing you to identify which webhooks are configured and manage them accordingly.

Authentication

Include the following headers in your requests:

Access-Token: <your-access-token>

Permissions

Ensure your API user has a role with external-api-get-webhook-list permission.

Endpoint

Request Parameters

This endpoint does not require any query parameters or request body. The customer_id is automatically extracted from your access token.

Response Codes

Code Description
200 OK Successfully retrieved the list of webhook configurations
401 Unauthorized Authentication credentials missing or incorrect
403 Forbidden User lacks permission to list webhook configurations
500 Internal Server Error Server error occurred

Response Body

The response is an array of webhook objects. Each object contains:

Field Type Description
id string (UUID) Unique identifier for the webhook configuration
created_at string (datetime) ISO timestamp when the configuration was created
webhook_url string The URL where notifications are sent
description string|null Human-readable description for the webhook

Response Example

[
  {
    "id": "0f8a681f-48ce-44f0-8e27-b8311c17b12a",
    "created_at": "2025-09-23T21:37:30.173622",
    "webhook_url": "https://example.com/webhook",
    "description": "Production webhook endpoint"
  },
  {
    "id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
    "created_at": "2025-09-24T10:15:00.000000",
    "webhook_url": "https://another.example.com/webhook",
    "description": "Development webhook endpoint"
  },
  {
    "id": "2b3c4d5e-6f78-9012-bcde-f12345678901",
    "created_at": "2025-09-25T14:20:15.123456",
    "webhook_url": "https://staging.example.com/webhook",
    "description": null
  },
  ...
]

Empty Response

If no webhooks are registered for your organization, the endpoint returns an empty array:

[]

Request Example

curl -L \
  --request GET \
  --url 'https://api.genlogs.io/alerts/webhook' \
  --header 'Access-Token: YOUR_ACCESS_TOKEN' \
  --header 'x-api-key: YOUR_API_KEY'

Notes