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

  • URL: https://api.genlogs.io/alerts/webhook

  • Method: GET

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

Empty Response

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

Request Example

Notes

  • The response only includes webhooks registered for your organization (determined by the customer_id in your access token).

  • The secret field is not included in the response for security reasons.

  • Use the id field to reference specific webhooks when updating or managing them via other endpoints.

  • The created_at timestamp helps identify when each webhook was registered.

List all webhooks for the authenticated customer

List Webhooks

get

List all webhooks for the authenticated customer

Authorizations
Access-TokenstringRequired

JWT Access Token required for authentication

Responses
chevron-right
200

Successful Response

application/json
Responseobject[]
get
/alerts/webhook
200

Successful Response

Last updated