Skip to content

Update

Update event subscription
patch/v1/event_subscriptions/{event_subscription_token}

Update an event subscription.

Path Parameters
event_subscription_tokenstring
Body Parameters
urlstring

URL to which event webhooks will be sent. URL must be a valid HTTPS address.

formaturi
descriptionstring
optional

Event subscription description.

disabledboolean
optional

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

event_typesarray of enum
optional

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

Hide ParametersShow Parameters
"account_holder.created"
"account_holder.updated"
"account_holder.verification"
"auth_rules.performance_report.created"
"balance.updated"
"book_transfer_transaction.created"
"card.created"
"card.renewed"
"card.reissued"
"card.converted"
"card.shipped"
"card_transaction.updated"
"digital_wallet.tokenization_approval_request"
"digital_wallet.tokenization_result"
"digital_wallet.tokenization_two_factor_authentication_code"
"digital_wallet.tokenization_two_factor_authentication_code_sent"
"digital_wallet.tokenization_updated"
"dispute.updated"
"dispute_evidence.upload_failed"
"external_bank_account.created"
"external_bank_account.updated"
"external_payment.created"
"external_payment.updated"
"financial_account.created"
"financial_account.updated"
"funding_event.created"
"loan_tape.created"
"loan_tape.updated"
"management_operation.created"
"management_operation.updated"
"payment_transaction.created"
"payment_transaction.updated"
"internal_transaction.created"
"internal_transaction.updated"
"settlement_report.updated"
"statements.created"
"three_ds_authentication.created"
"three_ds_authentication.updated"
"tokenization.approval_request"
"tokenization.result"
"tokenization.two_factor_authentication_code"
"tokenization.two_factor_authentication_code_sent"
"tokenization.updated"
Returns
tokenstringdescriptionstringdisabledbooleanurlstringevent_typesarray of enumEventSubscription
Request example Request
curl https://api.lithic.com/v1/event_subscriptions/$EVENT_SUBSCRIPTION_TOKEN \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "url": "https://example.com"
    }'
200 Example
{
  "token": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga1",
  "description": "description",
  "disabled": true,
  "url": "https://example.com",
  "event_types": [
    "account_holder.created"
  ]
}