v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
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/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

The Endpoint's ID or UID.

Response

keystring required

The endpoint's verification secret.

Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret.

Example response

{
  "key": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"
}