Set Up Webhooks

Set up your webhook endpoint and configure webhook events for which you want to receive payloads.

ZWITCH sends webhooks as an HTTP POST call. You need to configure a publically available HTTPS webhook endpoint URL to receive and store the payload. ZWITCH webhook payloads are in JSON format.

📘

HTTPS Must

We recommend using an HTTPS webhook endpoint URL to receive webhooks in live mode.

Multiple Webhook Endpoints

You could have different teams handling different parts of your business. For example, you could have different teams to handle the non-financial and financial parts of your business. The non-financial team would need webhook events related to account and beneficiary creation while the financial team would need events related to transfers and payments.

To handle these scenarios, ZWITCH allows you to configure multiple webhook endpoint URLs. You can configure up to 50 active webhook endpoint URLs on your ZWITCH account.

Set Up Webhooks

Follow the below steps to set up your webhook endpoint URL and configure events for which you want to receive payloads.

  1. Log into your ZWITCH Dashboard.
  2. Select the environment for which you want to set up the webhook endpoint URL.
  3. Navigate to DevelopersWebhooks.
  4. Click +Add Endpoint.
  5. Enter the required information on the Add a Webhook Endpoint popup.
    a. Endpoint URL: (mandatory) The HTTPS webhook endpoint URL where you want to receive and store the payloads.
    b. Description: A description for the webhook endpoint URL. This helps you identify the purpose of the endpoint and the events configured to it.
    c. Select the events for which you want to receive payloads using the Events to Send dropdown. Available webhook events.
  6. Click Add Endpoint.