SVsvix
Sink

Get Sink Secret

Changed on

Get the sink's signing secret (only supported for http sinks).

This is used to verify the authenticity of the delivery.

For more information please refer to the consuming webhooks docs.

get/api/v1/stream/{stream_id}/sink/{sink_id}/secret

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/stream/{stream_id}/sink/{sink_id}/secret
  • Auth
    HTTP bearer

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier
sink_idstring required

The StreamSink's ID or UID.

Example:unique-identifier

Response

keystring nullable

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