Retrieve a webhook endpoint

GET /api/v1/webhook_endpoints/{webhook_endpoint_id}

Retrieves the details of a webhook endpoint. You need only provide the unique webhook endpoint ID.

Path parameters

  • webhook_endpoint_id string Required

    The ID of the desired webhook endpoint (e.g., whe_KPGc5vEZdvoETu39BNwu2Z).

Responses

  • 200 application/json

    Returns a webhook endpoint object if a valid ID was provided.

    Hide response attributes Show response attributes object
    • created string
    • description string

      Optional human-readable description of the endpoint.

    • id string
    • secret string

      Webhook secret which you can use to verify that the webhook is from 1099Policy. Read more about how to use the webhook secret to verify the webhook signature in our documentation here.

    • url string

      The URL of the webhook endpoint.
GET /api/v1/webhook_endpoints/{webhook_endpoint_id} 
curl \
 -X GET https://api.1099policy.com/api/v1/webhook_endpoints/{webhook_endpoint_id}
Response examples (200) 
{
  "created": "2024-01-06T05:30:39.373Z",
  "description": "string",
  "id": "whe_KPGc5vEZdvoETu39BNwu2Z",
  "secret": false,
  "url": "https://example.com/my/webhook/endpoint"
}