Home
API reference
Platform API reference
Platform API
Destinations
Update webhook signing secret

Update webhook signing secret

post/v1/destinations/{destinationId}/changeWebhookSigningSecret
Page View

Destination endpoints allow you to manage destinations in a specified environment.

You must be a member of the environment and be assigned to an engineer role to manage destinations. Learn about roles.

Update webhook signing secret

Replace the existing webhook signing secret for a destination. The webhook signing secret gives you a cryptographically secure method to verify incoming requests from Redox.

Redox generates a new secret, which is returned in the response. The change takes effect immediately.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/destinations/{destinationId}/changeWebhookSigningSecret' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json'

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "secret": "string"
7
  }
8
}
  • meta
    object
    • version
      string

      Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.

  • payload
    object

    Response payload containing the new secret.

    • secret
      string

      A secure randomly-generated string that will be used to sign outbound webhook requests.