Event Types Reference
Jetpay webhooks support event types covering transactions, bank accounts, payments, user activities, and company changes.
Payment Events
Track the lifecycle of credit and debit transactions, as well as authorization and tokenization.
payments.transactions.credits.created
Fired when a credit transaction is created.
Example Data:
{
"transactionId": "550e8400-e29b-41d4-a716-446655440000",
"state": "PENDING"
}payments.transactions.credits.updated
Fired when a credit transaction state changes.
Example Data:
{
"transactionId": "550e8400-e29b-41d4-a716-446655440000",
"state": "COMPLETED"
}Example Data (Failed Transaction):
{
"transactionId": "550e8400-e29b-41d4-a716-446655440000",
"state": "FAILED",
"failReason": "NSF"
}Note: The failReason field is only present when the transaction state is FAILED.
payments.transactions.debits.created
Fired when a debit transaction is created.
Example Data:
{
"transactionId": "650e8400-e29b-41d4-a716-446655440001",
"state": "PENDING"
}payments.transactions.debits.updated
Fired when a debit transaction state changes.
Example Data:
{
"transactionId": "650e8400-e29b-41d4-a716-446655440001",
"state": "COMPLETED"
}Example Data (Failed Transaction):
{
"transactionId": "650e8400-e29b-41d4-a716-446655440001",
"state": "FAILED",
"failReason": "Bank account not verified"
}Note: The failReason field is only present when the transaction state is FAILED.
payments.contacts.creditCards.tokenization.success
Fired when a credit card is successfully tokenized via Adyen and set up as an unscheduled card on file.
Example Data:
{
"contactId": "950e8400-e29b-41d4-a716-446655440004",
"creditCardId": "a50e8400-e29b-41d4-a716-446655440005"
}Bank Account Events
Track bank account connections and updates.
payments.bankAccounts.created
Fired when a bank account is successfully linked to a contact.
Example Data:
{
"bankAccountId": "750e8400-e29b-41d4-a716-446655440002"
}Company and User Events
Track company and user lifecycle, authentication, and profile changes.
company.users.created
Fired when a new user account is created during signup.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006",
"email": "[email protected]"
}company.users.kyc.updated
Fired when a user's KYC (Know Your Customer) verification status is updated by the identity verification provider.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006"
}company.users.settings.updated
Fired when user settings (such as language preference) are changed.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006",
"settings": {
"language": "fr"
}
}company.users.permissions.updated
Fired when a company member's permissions or approval rights are modified by an owner.
Example Data:
{
"companyMemberId": "c50e8400-e29b-41d4-a716-446655440007",
"userId": "b50e8400-e29b-41d4-a716-446655440006",
"permission": "ADMIN",
"canApprove": true
}Note: companyMemberId refers to the member whose permissions were changed, while userId refers to the owner who made the change.
company.users.password.updated
Fired when a logged-in user successfully changes their password.
Example Data:
{}Note: This event contains an empty data object for privacy reasons.
company.users.login
Fired when a user successfully logs in.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006",
"email": "[email protected]"
}company.users.password.reset.requested
Fired when a user requests a password reset.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006",
"email": "[email protected]"
}company.users.password.reset.completed
Fired when a user successfully completes a password reset using a reset token.
Example Data:
{
"userId": "b50e8400-e29b-41d4-a716-446655440006"
}company.settings.updated
Fired when company settings are modified by an owner (such as security questions, payment methods, approval requirements, transaction limits, etc.).
Example Data:
{
"companyId": "d50e8400-e29b-41d4-a716-446655440008"
}company.kyc.updated
Fired when company KYC information is submitted or updated.
Example Data:
{
"companyId": "d50e8400-e29b-41d4-a716-446655440008"
}