Webhook Events

All important activity on your ZWITCH account is recorded as an event. We use webhooks to notify you about important events on your account. These webhooks contain details about the event such as changes that occurred and the resources impacted by the change.

We send webhooks as HTTP POST call to a URL configured by you. Webhook payloads use the JSON format.

Learn how to set up webhooks.

Available Webhook Events

The table below lists the various webhook events triggered when creating and maintaining cards.

Webhook Event	Description
`cards.created`	Triggered when a card is created.
`cards.updated`	Triggered whenever there is a status change for a card.
`cards.pin_set.updated`	Triggered when the PIN for a card is set or reset.
`cards.preferences.updated`	Triggered when the card preferences are updated.

Sample Payloads

Below are sample payloads for the different Cards webhook events.

Cards Created

Triggered when a card is created.

{
  "id": "evl_oOlJYkjSA99ysSYF2K0Cy6bHY",
  "object": "event",
  "name": "cards.created",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "car_66ED4BlpUP66etzOzbYWG6ib2",
      "object": "card",
      "type": "physical",
      "account_id": "sa_sbm9lbEPJ6EhRKZH7RBCQRRFEgj0",
      "kit_id": "100000897",
      "last_4": "6141",
      "status": "issued",
      "card_category": "debit",
      "name_on_card": "Anil Reddy",
      "mobile_number": "9845002376",
      "is_sandbox": true,
      "shipping_address": {
        "type": "communication",
        "address": "221B Baker Street, Marylebone Rd,",
        "landmark": "Next to Wollaton Hall",
        "city": "Bangalore",
        "state_code": "KA",
        "postal_code": "560005"
      },
      "created_at": 1679392020,
      "is_pin_set": false
    }
  }
}

Cards Updated

Triggered whenever there is a status change for a card.

{
  "id": "evl_oOlJYkjSA99ysSYF2K0Cy6bHY",
  "object": "event",
  "name": "cards.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "car_66ED4BlpUP66etzOzbYWG6ib2",
      "object": "card",
      "type": "physical",
      "account_id": "sa_sbm9lbEPJ6EhRKZH7RBCQRRFEgj0",
      "kit_id": "100000897",
      "last_4": "6141",
      "status": "active",
      "card_category": "debit",
      "name_on_card": "Anil Reddy",
      "mobile_number": "9845002376",
      "is_sandbox": true,
      "shipping_address": {
        "type": "communication",
        "address": "221B Baker Street, Marylebone Rd,",
        "landmark": "Next to Wollaton Hall",
        "city": "Bangalore",
        "state_code": "KA",
        "postal_code": "560005"
      },
      "created_at": 1679392020,
      "is_pin_set": false
    }
  }
}

Card PIN Set Updated

Triggered when the PIN for a card is set or reset.

{
  "id": "evl_MjqykIOpQZ1XxeuBDUwFdF6E1",
  "object": "event",
  "name": "cards.pin_set.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "pin_9JKW0993Z7HRmIHABuIwyVrB5",
      "object": "card_pin_set",
      "status": "success",
      "pin": "RxSIqW2oxOlxS6WDdcdbH9ft5HrmhiUVjn08v/voImdkKwGvrhE/wljsCXluKuTSTB20xKpocSbBEnqPTqgNPmFXATM9yAdWTRfdPLl+R5Q3qfSRv07iAL/aEMGj0DjqZTu1jn+JpA2k7n7hu7peQ5tqFKssP/ukJ5lJJI/sOldDAB0/ZCISkSoxczh4fZWqG7c13EOe0tY83Vgx07YRUfSmk4S3PBq+ljhW8LIc64V7i8fk+rTufcqKdrV/itx22dUMDmdKkuMkBtelH6tY3bJP6qCJQZOY1jDLilVf+LIhtTyDSA8bk2h60cy/8gDfNcYI3vUAf3r0G1bMDT+COw==",
      "pin_token_id": "pt_I5it0Xx4Sxdbc4fdGUNTGxsWU"
    }
  }
}

Card Preference Updated

Triggered when the card preferences are updated.

{
  "id": "evl_5zCzppud1mE550M52uT7rCmFH",
  "object": "event",
  "name": "cards.preferences.updated",
  "is_sandbox": true,
  "data": {
    "object": {
      "id": "crdpf_1N9YbnAu01LXxVLYfQl0zpimE",
      "object": "card_preference",
      "card_id": "car_rYHPZ6SJDAvSCekteluZ44sGS",
      "type": "physical",
      "account_id": "sa_DUsH5ydlmpMD9GewOihUrKfa9",
      "kit_id": "6660765432",
      "status": "active",
      "last_4": "9743",
      "preferences": {
        "transaction_modes": {
          "contactless": false,
          "atm": true,
          "pos": true,
          "ecom": true,
          "international": false
        },
        "limit_config": [
          {
            "txn_type": "atm",
            "max_amount": 1000
          },
          {
            "txn_type": "ecom",
            "max_amount": 1000
          },
          {
            "txn_type": "pos",
            "max_amount": 1000
          }
        ]
      },
      "is_sandbox": true,
      "created_at": 1652795520
    }
  }
}