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.

📘

Note

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

⚠️

Try It

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

Request parameters

  • merchantId
  • payoutAccountId

Response parameters

  • secret
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The body of the request requires a single merchant ID or payout account ID.

string

The merchant ID to create a secret for. The ID parameter name to use is merchantId.

Either this parameter or payoutAccountId is required.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json