Skip to main content

Webhook Credentials

Zuora

Webhook Credentials

You can add basic auth credentials for your webhooks for more secure communication. You can add credentials on the Webhook Credentials page and then apply the credentials when configuring webhooks.

Take the following steps to add a credential:

  1. Navigate to Settings > Webhook Credentials.
  2. Click + Add A Webhook Credential.
  3. In the Create Webhook Credentials window that opens, enter the following:
    1. Specify a name for the credential.
    2. Select the method to authenticate and authorize access to the webhook endpoint from one of the following options:
      • Basic Auth - Sends credentials (usually a username and password) with each request to authenticate the user or application.
      • Bearer Token - Uses a token (e.g., JWT) instead of credentials, included in the Authorization header of each request.
    3. Enter the username and password. You can click Show password to display the entered password. 

After a credential is created, you will not be able to see the value of the password field again.

  1. Click Create to save the credential.

The newly created credential will show up on the webhook credential list.

For more information about how to add the credential to a webhook, see Webhooks.

Pay attention to the following notes on webhook credentials:

  • You cannot delete credentials that are used by a webhook.
  • To apply the credentials for a webhook, the target endpoint must use HTTPS.