Skip to content
HitchPay API Docs

Webhooks

Customer Profile Update

Fired when a customer's profile is updated or the profile is deleted.

Use this webhook to

  • Keep your own customer records in sync after a correction
  • Know when a customer profile has been closed, so you can stop referencing it

Events

Event Fired when
customer.updated A customer's profile is edited via Update Customer
customer.deleted A customer's profile is closed via Delete Customer

Payloads

customer.updated

{
  "event": "customer.updated",
  "data": {
    "uuid": "…",
    "customerid": "your-customer-ref-001",
    "firstname": "Jonathan",
    "lastname": "Doe",
    "email": "[email protected]",
    "phone": "08012345678",
    "kyc_status": "pending_kyc"
  }
}

customer.deleted

{
  "event": "customer.deleted",
  "data": {
    "uuid": "…",
    "customerid": "your-customer-ref-001",
    "deleted": true,
    "accounts_closed": 1
  }
}

Payload fields

Field Type Description
uuid string Customer id
customerid string Your reference
firstname / lastname / email / phone string Updated fields -customer.updated only
kyc_status string Status after the update - reset to pending_kyc if an identity field changed
deleted boolean Always true -customer.deleted only
accounts_closed number Count of unfunded accounts closed by the deletion - customer.deleted only

Questions? Email [email protected]. Also on GitBook.