Skip to main content
GET
/
v1
/
webhooks
/
endpoints
/
{endpointId}
Get Webhook Endpoint
curl --request GET \
  --url https://your-endpoint.moduluslabs.io/v1/webhooks/endpoints/{endpointId} \
  --header 'x-api-key: <api-key>'
{
  "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"
}
This endpoint requires HMAC-SHA256 authentication. See Authentication for signature computation details.

​
Response Details

Returns the complete configuration of the specified webhook endpoint, including:
  • URL where webhooks are delivered
  • Subscribed event types
  • Current status (active or disabled)
  • Custom metadata
  • Creation and update timestamps
The webhook signing secret is not included in get responses. It is only returned once during endpoint creation.

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.

Path Parameters

​
endpointId
string
required

The unique identifier of the webhook endpoint

Response

Webhook endpoint details

​
endpointId
string
required

Unique identifier for the webhook endpoint.

​
url
string<uri>
required

The HTTPS URL where webhook payloads are delivered.

​
events
enum<string>[]
required

Event types this endpoint is subscribed to.

Available options:
payment.completed,
payment.failed,
payment.cancelled,
payment.timeout
​
status
enum<string>
required

Endpoint status.

Available options:
active,
disabled
​
createdAt
string<date-time>
required

ISO 8601 timestamp of when the endpoint was created.

​
updatedAt
string<date-time>
required

ISO 8601 timestamp of the last update.

​
description
string

Human-readable description for this endpoint.

​
metadata
object

Custom key-value pairs associated with this endpoint.