Endpoint

Get Endpoint Secret

Changed on

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

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/endpoint/{endpoint_id}/secret
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier
endpoint_idstring required

The Endpoint's ID or UID.

Example:unique-identifier

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"
}

Changes