Create a Webhook

Create a webhook endpoint with a url and a list of events.
Webhooks
Create a Webhook
 last updated: 
March 9, 2022

ENDPOINT

  1. POST /v1/webhook

REQUEST

  1. {
  2.     "url": "https://bc5cc9365df4e38d7bda89b7e8c8f568.m.pipedream.net",
  3.     "events": [
  4.         "person.kyc.approved",
  5.         "person.kyc.declined",
  6.         "person.kyc.review",
  7.         "business.kyb.approved",
  8.         "business.kyb.declined",
  9.         "business.kyb.review",
  10.         "card.refund",
  11.         "card.reversal",
  12.         "card.spend",
  13.         "card.spend.update",
  14.         "card.declined",
  15.         "intrabank.originated.credit",
  16.         "intrabank.originated.debit",
  17.         "intrabank.received.credit",
  18.         "intrabank.received.debit",
  19.         "ach.originated.credit",
  20.         "ach.originated.debit",
  21.         "ach.received.credit",
  22.         "ach.received.debit",
  23.         "wire.received.credit",
  24.         "wire.originated.debit",
  25.         "check.originated.debit",
  26.         "check.originated.credit",
  27.         "account.debit",
  28.         "account.credit",
  29.         "ach.reversal.credit",
  30.         "ach.reversal.debit",
  31.         "wire.reversal.debit",
  32.         "wire.reversal.credit",
  33.         "check.reversal.debit",
  34.         "check.reversal.credit",
  35.         "solidcard.originated.debit",
  36.         "solidcard.reversal.credit"
  37.     ],
  38.     "description": "Webhook Subsciption",
  39.     "status": "active"
  40. }

RESPONSE

  1. {
  2.     "id": "wbh-ab5561ce-252d-464e-92e6-0e36436be214",
  3.     "programId": "prg-b9f17601-4717-460e-bda5-9598f6f6db28",
  4.     "events": [
  5.         "person.kyc.approved",
  6.         "person.kyc.declined",
  7.         "person.kyc.review",
  8.         "business.kyb.approved",
  9.         "business.kyb.declined",
  10.         "business.kyb.review",
  11.         "card.refund",
  12.         "card.reversal",
  13.         "card.spend",
  14.         "card.spend.update",
  15.         "card.declined",
  16.         "intrabank.originated.credit",
  17.         "intrabank.originated.debit",
  18.         "intrabank.received.credit",
  19.         "intrabank.received.debit",
  20.         "ach.originated.credit",
  21.         "ach.originated.debit",
  22.         "ach.received.credit",
  23.         "ach.received.debit",
  24.         "wire.received.credit",
  25.         "wire.originated.debit",
  26.         "check.originated.debit",
  27.         "check.originated.credit",
  28.         "account.debit",
  29.         "account.credit",
  30.         "ach.reversal.credit",
  31.         "ach.reversal.debit",
  32.         "wire.reversal.debit",
  33.         "wire.reversal.credit",
  34.         "check.reversal.debit",
  35.         "check.reversal.credit",
  36.         "solidcard.originated.debit",
  37.         "solidcard.reversal.credit"
  38.     ],
  39.     "url": "https://bc5cc9365df4e38d7bda89b7e8c8f568.m.pipedream.net",
  40.     "status": "active",
  41.     "description": "Webhook Subsciption",
  42.     "createdAt": "2021-12-20T00:47:14Z",
  43.     "modifiedAt": "2021-12-20T00:47:14Z"
  44. }