Skip to main content
GET
/
v1
/
webhooks
/
endpoints
List Webhook Endpoints
curl --request GET \
  --url https://your-endpoint.moduluslabs.io/v1/webhooks/endpoints \
  --header 'x-api-key: <api-key>'
{
  "endpoints": [
    {
      "endpointId": "wh_01HQ3K4M5N6P7R8S9T0UVWXYZ",
      "url": "https://api.yourcompany.com/webhooks/payments",
      "events": [
        "payment.completed",
        "payment.failed",
        "payment.cancelled",
        "payment.timeout"
      ],
      "description": "Production payment notifications",
      "status": "active",
      "metadata": {
        "environment": "production"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "count": 1,
  "timestamp": "2024-01-15T10:35:00.000Z"
}
This endpoint requires HMAC-SHA256 authentication. See Authentication for signature computation details.

​
Response Details

The response includes all webhook endpoints configured for your group, including:
  • Active endpoints that are receiving webhooks
  • Disabled endpoints that have been paused but not deleted
The webhook signing secret is not included in list responses. It is only returned once during endpoint creation.

​
Endpoint Status

StatusDescription
activeEndpoint is receiving webhook deliveries
disabledEndpoint is paused; no webhooks are delivered

Authorizations

​
x-api-key
string
header
required

HMAC-SHA256 authentication. Requires three headers: x-api-key (your API key), x-timestamp (ISO 8601 timestamp), and x-signature (Base64-encoded HMAC-SHA256 signature). See Authentication documentation for signature computation.

Response

List of webhook endpoints

​
endpoints
object[]
required

List of webhook endpoints

​
count
integer
required

Total number of endpoints

​
timestamp
string<date-time>
required

ISO 8601 timestamp of the response