v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB

Endpoint

Get Endpoint Secret

Get the endpoint's signing secret.

This is used to verify the authenticity of the webhook. For more information please refer to the consuming webhooks docs.

get/endpoint/{endpoint_id}/secret

Path parameters

endpoint_idstring required

The ep's ID or UID

Example:unique-ep-identifier

The ep's ID or UID To retrieve your endpoints ids, use GET /endpoint.

Response

keystring required

The endpoint's verification secret. If null is passed, a secret is automatically generated. Format: base64 encoded random bytes optionally prefixed with whsec_. Recommended size: 24.

Example response

{
  "key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}