Sign in

v1

latestOpenAPI 3.0.0ISC2026-07-249501.1 MB
Webhook Service

Create a webhook secret

Creates a secret to be used in legacy webhooks for a merchant account or payout account.

Set up a webhook secret for additional security. After you create a secret, each webhook includes a header containing a signature. You can use the signature to verify that all data received is authentic.

For a tutorial about configuring and using webhooks, see Configuring legacy webhooks in Guides.

<!-- theme: info -->

📘 Note

For the current workflow, see the Register webhook URLs endpoint instead.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

<div style="display:none;">

Request parameters

  • merchantId
  • payoutAccountId

Response parameters

  • secret
</div>
post/webhook/v3/secret

Request body

OR

Example request

{
  "merchantId": "000999"
}

Response

Success

secretstring

The secret to be used in verifying the webhook's signature. Store the secret in a secure location in order to use it for that verification process.

For a tutorial about verifying the signature, see Receiving webhooks in Guides.

Example response

{
  "secret": "446946d5-bdd9-48c7-9504-0459d19c08e5"
}