Create event subscription

Event Subscription

Description

Event subscription description.

Disabled

Whether the event subscription is active (false) or inactive (true). Defaults to false.

Event Types

Indicates types of events that will be sent to this subscription. If left blank, all types will be sent.

Possible Values:

• account_holder_document.updated: Occurs when an account holder's document upload status has been updated.
• account_holder.created: Occurs when a new account_holder is created.
• account_holder.updated: Occurs when an account_holder is updated.
• account_holder.verification: Occurs when an asynchronous account_holder's verification is completed.
• auth_rules.backtest_report.created: Auth Rules backtest report created.
• balance.updated: Financial Account Balance Update.
• book_transfer_transaction.created: Occurs when a book transfer transaction is created.
• book_transfer_transaction.updated: Occurs when a book transfer transaction is updated.
• card_authorization.challenge: Occurs when an Out of Band challenge is issued during card authorization.
• card_authorization.challenge_response: Occurs when a cardholder responds to a challenge during card authorization.
• card_transaction.enhanced_data.created: Occurs when L2/L3 enhanced commercial data is processed for a transaction event.
• card_transaction.enhanced_data.updated: Occurs when L2/L3 enhanced commercial data is reprocessed for a transaction event.
• card_transaction.updated: Occurs when a card transaction happens.
• card.converted: Occurs when a card is converted from virtual to physical cards.
• card.created: Occurs when a new card is created.
• card.reissued: Occurs when a card is reissued.
• card.renewed: Occurs when a card is renewed.
• card.shipped: Occurs when a card is shipped.
• card.updated: Occurs when a card is updated.
• claim_document.accepted: Occurs when a claim document passes validation and is accepted.
• claim_document.rejected: Occurs when a claim document fails validation and is rejected.
• claim_document.uploaded: Occurs when a claim document is uploaded and begins validation.
• claim.created: Occurs when a dispute intake claim is created.
• claim.updated: Occurs when a dispute intake claim is updated.
• digital_wallet.tokenization_result: Occurs when a tokenization request succeeded or failed. (Deprecated)
• dispute_evidence.upload_failed: Occurs when an evidence upload fails for a dispute filed through the Chargebacks API.
• ... (other events)

Example Request

{
  "description": "string",
  "disabled": false,
  "event_types": [
    "account_holder_document.updated"
  ],
  "url": "string"
}

Example Response

{
  "description": "A subscription for all events",
  "disabled": false,
  "token": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga1",
  "url": "https://example.com/webhook"
}