Events
Some events that occur within Kobana are recorded.
All of them, when recorded, generate notifications for each webhook that is active and configured to receive the respective event. You can access the Event Log of your account at any time.
The codes follow a dotted hierarchical namespace started by the resource that generated the event. Simple lifecycle events use resource.action (e.g.: bank_billet.paid) or resource.db.action for CRUD (e.g.: webhook.db.created).
Command events (asynchronous operations with the bank) follow resource[.type].operation.status, where operation is the operation (register, approve, cancel…) and status contains requested, confirmed, failed, error (e.g.: transfer.ted_batch.register.confirmed).
List of events
| Code | Description |
|---|---|
| access_token.db.created | Access token created. |
| access_token.db.deleted | Access token deleted. |
| access_token.db.updated | Access token updated. |
| access_token.expired | Access token expired. |
| access_token.reminder | Access token expiration reminder. |
| account.bank_billet_creation_blocked | Every time boleto issuance is blocked. |
| account.blocked | Every time the account is blocked. |
| account.updated | Every time the account is updated. |
| addon.activated | Every time an add-on is activated. |
| addon.removed | Every time an add-on is removed. |
| bank_billet.add_pix.confirmed | Pix addition to boleto confirmed. |
| bank_billet.add_pix.error | An error occurred when adding Pix to boleto. |
| bank_billet.add_pix.failed | Failure in adding Pix to boleto. |
| bank_billet.add_pix.requested | Pix addition to boleto requested. |
| bank_billet.blocked | Every time a boleto payment is blocked. |
| bank_billet.cancel.confirmed | Every time boleto cancellation is confirmed. |
| bank_billet.cancel.error | Every time an error occurs in boleto cancellation. |
| bank_billet.cancel.failed | Every time boleto cancellation has a permanent failure. |
| bank_billet.cancel.requested | Every time boleto cancellation is requested. |
| bank_billet.canceled | Every time a boleto is canceled. |
| bank_billet.created | Every time a boleto is created. |
| bank_billet.deleted | Every time a boleto is deleted. |
| bank_billet.due_date (discontinued) | Every time a boleto is notified X days before due date. |
| bank_billet.find.confirmed | Boleto search confirmed. |
| bank_billet.find.error | An error occurred in boleto search. |
| bank_billet.find.failed | Failure in boleto search. |
| bank_billet.find.requested | Boleto search requested. |
| bank_billet.generated | Every time a boleto PDF is generated. |
| bank_billet.overdue | Every time a boleto becomes overdue. |
| bank_billet.paid | Every time a boleto is paid. |
| bank_billet.protest.confirmed | Boleto protest confirmed. |
| bank_billet.protest.error | An error occurred in boleto protest. |
| bank_billet.protest.failed | Failure in boleto protest. |
| bank_billet.protest.requested | Boleto protest requested. |
| bank_billet.register.confirmed | Every time boleto registration is confirmed. |
| bank_billet.register.error | Every time an error occurs in boleto registration. |
| bank_billet.register.failed | Every time boleto registration has a permanent failure. |
| bank_billet.register.requested | Every time boleto registration is requested. |
| bank_billet.registered | Every time a boleto is registered with the bank. |
| bank_billet.rejected | Every time a boleto is rejected by the bank. |
| bank_billet.update.confirmed | Every time a boleto update is confirmed. |
| bank_billet.update.error | Every time an error occurs in boleto update. |
| bank_billet.update.failed | Every time a boleto update has a permanent failure. |
| bank_billet.update.requested | Every time a boleto update is requested. |
| bank_billet.updated | Every time a boleto is updated. |
| bank_billet_account.activated | Every time a collection portfolio is activated. |
| bank_billet_account.created | Every time a collection portfolio is created. |
| bank_billet_account.deleted | Every time a collection portfolio is deleted. |
| bank_billet_account.homologated (discontinued) | Every time a collection portfolio is homologated. |
| bank_billet_account.homologation_failed | Every time a collection portfolio homologation fails. |
| bank_billet_account.homologation_started | Every time a collection portfolio is sent for homologation. |
| bank_billet_account.updated | Every time a collection portfolio is updated. |
| bank_billet_account.validated (discontinued) | Every time a collection portfolio is validated. |
| bank_billet_account.validation_released | Every time a collection portfolio is sent for validation. |
| bank_billet_discharge.created | Every time a return record is created. |
| bank_billet_discharge.deleted | Every time a return record is deleted. |
| bank_billet_discharge.updated | Every time a return record is updated. |
| bank_billet_payment.created | Every time a payment is created. |
| bank_billet_payment.deleted | Every time a payment is deleted. |
| bank_billet_payment.updated | Every time a payment is updated. |
| bank_billet_registration.created | Every time a boleto registration is created. |
| bank_billet_registration.deleted | Every time a boleto registration is deleted. |
| bank_billet_registration.updated | Every time a boleto registration is updated. |
| bank_billet_remittance.created | Every time a remittance record is created. |
| bank_billet_remittance.deleted | Every time a remittance record is deleted. |
| bank_billet_remittance.updated | Every time a remittance record is updated. |
| charge.automatic_pix.account.db.created | Automatic Pix collection account created. |
| charge.automatic_pix.account.db.deleted | Automatic Pix collection account deleted. |
| charge.automatic_pix.account.db.updated | Automatic Pix collection account updated. |
| charge.automatic_pix.pix.cancel.confirmed | Automatic Pix collection cancellation confirmed. |
| charge.automatic_pix.pix.cancel.error | An error occurred in automatic Pix collection cancellation. |
| charge.automatic_pix.pix.cancel.failed | Failure in automatic Pix collection cancellation. |
| charge.automatic_pix.pix.cancel.requested | Automatic Pix collection cancellation requested. |
| charge.automatic_pix.pix.db.created | Every time an automatic Pix collection is created. |
| charge.automatic_pix.pix.db.deleted | Every time an automatic Pix collection is deleted. |
| charge.automatic_pix.pix.db.updated | Automatic Pix collection updated. |
| charge.automatic_pix.pix.register.confirmed | Automatic Pix collection registration confirmed. |
| charge.automatic_pix.pix.register.error | An error occurred in automatic Pix collection registration. |
| charge.automatic_pix.pix.register.failed | Failure in automatic Pix collection registration. |
| charge.automatic_pix.pix.register.requested | Automatic Pix collection registration requested. |
| charge.automatic_pix.pix.update.confirmed | Automatic Pix collection update confirmed. |
| charge.automatic_pix.pix.update.error | An error occurred in automatic Pix collection update. |
| charge.automatic_pix.pix.update.failed | Failure in automatic Pix collection update. |
| charge.automatic_pix.pix.update.requested | Automatic Pix collection update requested. |
| charge.automatic_pix.recurrence.cancel.confirmed | Automatic Pix recurrence cancellation confirmed. |
| charge.automatic_pix.recurrence.cancel.error | An error occurred in automatic Pix recurrence cancellation. |
| charge.automatic_pix.recurrence.cancel.failed | Failure in automatic Pix recurrence cancellation. |
| charge.automatic_pix.recurrence.cancel.requested | Automatic Pix recurrence cancellation requested. |
| charge.automatic_pix.recurrence.db.created | Every time an automatic Pix recurrence is created. |
| charge.automatic_pix.recurrence.db.deleted | Every time an automatic Pix request is deleted. |
| charge.automatic_pix.recurrence.db.updated | Every time an automatic Pix request is updated. |
| charge.automatic_pix.recurrence.register.confirmed | Automatic Pix recurrence registration confirmed. |
| charge.automatic_pix.recurrence.register.error | An error occurred in automatic Pix recurrence registration. |
| charge.automatic_pix.recurrence.register.failed | Failure in automatic Pix recurrence registration. |
| charge.automatic_pix.recurrence.register.requested | Automatic Pix recurrence registration requested. |
| charge.automatic_pix.recurrence.update.confirmed | Automatic Pix recurrence update confirmed. |
| charge.automatic_pix.recurrence.update.error | An error occurred in automatic Pix recurrence update. |
| charge.automatic_pix.recurrence.update.failed | Failure in automatic Pix recurrence update. |
| charge.automatic_pix.recurrence.update.requested | Automatic Pix recurrence update requested. |
| charge.automatic_pix.request.cancel.confirmed | Automatic Pix recurrence request cancellation confirmed. |
| charge.automatic_pix.request.cancel.error | An error occurred in automatic Pix recurrence request cancellation. |
| charge.automatic_pix.request.cancel.failed | Failure in automatic Pix recurrence request cancellation. |
| charge.automatic_pix.request.cancel.requested | Automatic Pix recurrence request cancellation requested. |
| charge.automatic_pix.request.db.created | Every time an automatic Pix request is created. |
| charge.automatic_pix.request.db.deleted | Every time an automatic Pix request is deleted. |
| charge.automatic_pix.request.db.updated | Automatic Pix recurrence requests updated. |
| charge.automatic_pix.request.register.confirmed | Automatic Pix recurrence request registration confirmed. |
| charge.automatic_pix.request.register.error | An error occurred in automatic Pix recurrence request registration. |
| charge.automatic_pix.request.register.failed | Failure in automatic Pix recurrence request registration. |
| charge.automatic_pix.request.register.requested | Automatic Pix recurrence request registration requested. |
| charge.bank_billet.payment.canceled | Every time a boleto payment is canceled at the financial institution. |
| charge.bank_billet.payment.confirmed | Every time a boleto payment is effectuated at the financial institution. |
| charge.bank_billet.payment.notified | Every time a boleto payment is notified by the financial institution. |
| charge.payment.canceled | Collection canceled. |
| charge.payment.confirmed | Collection confirmed. |
| charge.payment.db.created | Every time a collection is created in the database. |
| charge.payment.db.deleted | Every time a collection is deleted from the database. |
| charge.payment.db.updated | Every time a collection is updated in the database. |
| charge.payment.duplicated | Duplicate collection. |
| charge.payment.notified | Collection notified. |
| connection.db.created (discontinued) | Connection created. |
| connection.db.deleted (discontinued) | Connection deleted. |
| connection.db.updated (discontinued) | Connection updated. |
| credit.restriction.add.confirmed | Every time credit restriction inclusion is confirmed. |
| credit.restriction.add.error | Every time an error occurs in credit restriction inclusion. |
| credit.restriction.add.failed | Every time credit restriction inclusion fails. |
| credit.restriction.add.requested | Every time credit restriction inclusion is requested. |
| credit.restriction.remove.confirmed | Every time credit restriction removal is confirmed. |
| credit.restriction.remove.error | Every time an error occurs in credit restriction removal. |
| credit.restriction.remove.failed | Every time credit restriction removal fails. |
| credit.restriction.remove.requested | Every time credit restriction removal is requested. |
| customer.created | Every time a customer is created. |
| customer.deleted | Every time a customer is deleted. |
| customer.portal_password_updated | Every time the customer portal password is updated. |
| customer.updated | Every time a customer is updated. |
| customer_subscription.created | Every time a subscription is created. |
| customer_subscription.deleted | Every time a subscription is deleted. |
| customer_subscription.updated | Every time a subscription is updated. |
| data.bank_billet_query.db.created | Boleto query created. |
| data.bank_billet_query.db.deleted | Boleto query deleted. |
| data.bank_billet_query.db.updated | Boleto query updated. |
| data.bank_billet_query.error | Boleto query with error. |
| data.bank_billet_query.success | Boleto query completed successfully. |
| data.pix_qrcode_query.db.created | Pix QR Code query created. |
| data.pix_qrcode_query.db.deleted | Pix QR Code query deleted. |
| data.pix_qrcode_query.db.updated | Pix QR Code query updated. |
| data.pix_qrcode_query.error | Pix QR Code query with error. |
| data.pix_qrcode_query.success | Pix QR Code query completed successfully. |
| discharge.created | Every time a return is created. |
| discharge.deleted | Every time a return is deleted. |
| discharge.processed | Every time a return is processed. |
| edi.edi_box.activated | Every time an EDI is activated. |
| edi.edi_box.confirming_at_bank | Awaiting bank confirmation |
| edi.edi_box.db.created | Every time an EDI is created. |
| edi.edi_box.db.deleted | Every time an EDI is deleted. |
| edi.edi_box.db.updated | Every time an EDI is updated. |
| edi.edi_box.demand_received | Demand received |
| edi.edi_box.generated | Letter generated. |
| edi.edi_box.testing_by_customer | Awaiting customer testing. |
| edi.edi_box.waiting_for_validations | Awaiting validations. |
| edi.remittance_line.created | Remittance line created. |
| edi.remittance_line.deleted | Remittance line deleted. |
| edi.remittance_line.updated | Remittance line updated. |
| email_account.db.created | Email account created. |
| email_account.db.deleted | Email account deleted. |
| email_account.db.updated | Email account updated. |
| email_account.dns.awaiting | Awaiting DNS validation. |
| email_account.dns.error | DNS validation failed. |
| email_account.dns.failure | DNS attempt failure. |
| email_account.dns.not_ready | DNS not ready. |
| email_account.dns.validated | DNS validated. |
| email_account.identity.created | Identity created. |
| email_account.identity.error | Identity already exists. |
| email_account.identity.failure | Identity failure. |
| email_account.identity.pending | Awaiting identity. |
| enotas.nfe.generated | Enotas: fiscal note generated |
| export.db.created | Export created. |
| export.db.deleted | Export deleted. |
| export.db.updated | Export updated. |
| financial.account.balance.updated | Every time a financial account balance is updated. |
| financial.account.db.created | Financial account created. |
| financial.account.db.deleted | Financial account deleted. |
| financial.account.db.updated | Financial account updated. |
| financial.account.statement.updated | Every time a statement is updated. (Whether by CNAB import or bank API synchronization) |
| financial.account_balance.db.created | Balance created. |
| import.created | Every time an import is created. |
| import.deleted | Every time an import is deleted. |
| import.processed | Every time an import is processed. |
| installment.created | Every time an installment plan is created. |
| installment.deleted | Every time an installment plan is deleted. |
| installment.generated | Every time all installments of a plan are generated. |
| installment.processed | Every time all installments of a plan are processed. |
| integration.connection.db.created | Connection created. |
| integration.connection.db.deleted | Connection deleted. |
| integration.connection.db.updated | Connection updated. |
| mailbox.channel.email.db.created | Mailbox email channel created. |
| mailbox.channel.email.db.deleted | Mailbox email channel deleted. |
| mailbox.channel.email.db.updated | Mailbox email channel updated. |
| mailbox.channel.s3.db.created | Mailbox S3 channel created. |
| mailbox.channel.s3.db.deleted | Mailbox S3 channel deleted. |
| mailbox.channel.s3.db.updated | Mailbox S3 channel updated. |
| mailbox.channel.s3.fetch_all | Mailbox file obtained from S3 channel. |
| mailbox.channel.sftp.db.created | Mailbox SFTP channel created. |
| mailbox.channel.sftp.db.deleted | Mailbox SFTP channel deleted. |
| mailbox.channel.sftp.db.updated | Mailbox SFTP channel updated. |
| mailbox.channel.sftp.fetch_all | Mailbox file obtained from SFTP channel. |
| mailbox.channel.syncthing.db.created | Mailbox Syncthing channel created. |
| mailbox.channel.syncthing.db.deleted | Mailbox Syncthing channel deleted. |
| mailbox.channel.syncthing.db.updated | Mailbox Syncthing channel updated. |
| mailbox.channel.whatsapp.db.created | Mailbox WhatsApp channel created. |
| mailbox.channel.whatsapp.db.deleted | Mailbox WhatsApp channel deleted. |
| mailbox.channel.whatsapp.db.updated | Mailbox WhatsApp channel updated. |
| mailbox.entry.db.created | Mailbox entry created. |
| mailbox.entry.db.deleted | Mailbox entry deleted. |
| mailbox.entry.db.updated | Mailbox entry updated. |
| mailbox.entry.file.received | Mailbox file received in the inbox. |
| mailbox.entry.file.sent | Mailbox file sent to the outbox. |
| mailbox.file.db.created | Mailbox file created. |
| mailbox.file.db.deleted | Mailbox file deleted. |
| mailbox.file.db.updated | Mailbox file updated. |
| payment.approve.confirmed (discontinued) | Payment release confirmed. |
| payment.approve.error (discontinued) | An error occurred in payment release. |
| payment.approve.failed (discontinued) | Failure in payment release. |
| payment.approve.requested (discontinued) | Payment release requested. |
| payment.batch.awaiting_approval | Payment batch awaiting release. |
| payment.batch.db.created | Payment batch created. |
| payment.batch.db.deleted | Payment batch deleted. |
| payment.batch.db.updated | Payment batch updated. |
| payment.cancel.confirmed (discontinued) | Every time a payment cancellation is confirmed. |
| payment.cancel.error (discontinued) | Every time an error occurs in payment cancellation. |
| payment.cancel.failed (discontinued) | Every time a payment cancellation fails. |
| payment.cancel.requested (discontinued) | Every time a payment cancellation is requested. |
| payment.db.created | Every time a payment is created in the database. |
| payment.db.deleted | Every time a payment is deleted from the database. |
| payment.db.updated | Every time a payment is updated in the database. |
| payment.dda.account.confirmed | DDA account approved. |
| payment.dda.account.db.created | DDA account created. |
| payment.dda.account.db.deleted | DDA account deleted. |
| payment.dda.account.db.updated | DDA account updated. |
| payment.dda.account.disabled | DDA account disabled. |
| payment.dda.account.enabled | DDA account re-enabled. |
| payment.dda.account.failed | DDA account failure. |
| payment.dda.account.letter.failed | Failure in DDA letter signature process. |
| payment.dda.account.letter.pending | DDA letter generated and sent for signature. |
| payment.dda.account.letter.signed | DDA letter signed by all signatories. |
| payment.dda.account.letter.waiting_signatures | DDA letter awaiting signatures. |
| payment.dda.account.register.confirmed | DDA account registration confirmed. |
| payment.dda.account.register.error | An error occurred in DDA account registration. |
| payment.dda.account.register.failed | Failure in DDA account registration. |
| payment.dda.account.register.requested | DDA account registration requested. |
| payment.dda.account.rejected | DDA account rejected. |
| payment.dda.account.unregister.confirmed | DDA account unregistration confirmed. |
| payment.dda.account.unregister.error | An error occurred in DDA account unregistration. |
| payment.dda.account.unregister.failed | Failure in DDA account unregistration. |
| payment.dda.account.unregister.requested | DDA account unregistration requested. |
| payment.dda.bank_billet.db.created | DDA boleto synced from the bank. |
| payment.dda.bank_billet.db.updated | DDA boleto updated (released or rejected). |
| payment.dda.bank_billet.external_status_changed | DDA boleto external status changed by the bank. |
| payment.payment_batch.approve.confirmed (discontinued) | Every time a payment batch approval at the financial institution is confirmed. |
| payment.payment_batch.approve.error (discontinued) | Every time an error occurs in payment batch approval at the financial institution. |
| payment.payment_batch.approve.failed (discontinued) | Every time a payment batch approval at the financial institution fails. |
| payment.payment_batch.approve.requested (discontinued) | Every time a payment batch approval at the financial institution is requested. |
| payment.payment_batch.awaiting_approval (discontinued) | Every time the financial institution requests approval or rejection of a payment batch. |
| payment.payment_batch.db.created (discontinued) | Every time a payment batch is created in the database. |
| payment.payment_batch.db.deleted (discontinued) | Every time a payment batch is deleted from the database. |
| payment.payment_batch.db.updated (discontinued) | Every time a payment batch is updated in the database. |
| payment.payment_batch.register.confirmed (discontinued) | Every time a payment batch registration at the financial institution is confirmed. |
| payment.payment_batch.register.error (discontinued) | Every time an error occurs in payment batch registration at the financial institution. |
| payment.payment_batch.register.failed (discontinued) | Every time a payment batch registration at the financial institution fails. |
| payment.payment_batch.register.requested (discontinued) | Every time a payment batch registration at the financial institution is requested. |
| payment.payment_batch.reprove.confirmed (discontinued) | Every time a payment batch rejection at the financial institution is confirmed. |
| payment.payment_batch.reprove.error (discontinued) | Every time an error occurs in payment batch rejection at the financial institution. |
| payment.payment_batch.reprove.failed (discontinued) | Every time a payment batch rejection at the financial institution fails. |
| payment.payment_batch.reprove.requested (discontinued) | Every time a payment batch rejection at the financial institution is requested. |
| payment.register.confirmed (discontinued) | Every time a payment registration at the financial institution is confirmed. |
| payment.register.error (discontinued) | Every time an error occurs in payment registration at the financial institution. |
| payment.register.failed (discontinued) | Every time a payment registration at the financial institution fails. |
| payment.register.requested (discontinued) | Every time a payment registration at the financial institution is requested. |
| pix.cancel.confirmed | Every time a Pix cancellation is confirmed. |
| pix.cancel.error | Every time an error occurs in Pix cancellation. |
| pix.cancel.failed | Every time a Pix cancellation has a permanent failure. |
| pix.cancel.requested | Every time a Pix cancellation is requested. |
| pix.db.created | Every time a Pix is created in the database. |
| pix.db.deleted | Every time a Pix is deleted from the database. |
| pix.db.updated | Every time a Pix is updated in the database. |
| pix.overdue | Every time a Pix charge becomes overdue. |
| pix.paid | Every time confirmation of Pix payment is received. |
| pix.register.confirmed | Every time a Pix registration is confirmed. |
| pix.register.error | Every time an error occurs in Pix registration. |
| pix.register.failed | Every time a Pix registration has a permanent failure. |
| pix.register.requested | Every time a Pix registration is requested. |
| pix.update.confirmed | Every time a Pix update is confirmed. |
| pix.update.error | Every time an error occurs in Pix update. |
| pix.update.failed | Every time a Pix update has a permanent failure. |
| pix.update.requested | Every time a Pix update is requested. |
| plan_subscription.activated | Every time a plan is activated. |
| plan_subscription.fee | Every time a plan is charged. |
| plan_subscription.removed | Every time a plan is deactivated. |
| plan_subscription.updated | Every time a plan is updated. |
| remittance.created | Every time a remittance is created. |
| remittance.deleted | Every time a remittance is deleted. |
| remittance.downloaded | Every time a remittance is downloaded. |
| remittance.line.db.created | Every time a remittance line is created. |
| remittance.line.db.deleted | Every time a remittance line is deleted. |
| remittance.line.db.updated | Every time a remittance line is updated. |
| remittance.processed | Every time a remittance is processed. |
| remittance.sent | Every time a remittance is sent. (Only when automatic sending is contracted) |
| transaction.created | Every time a transaction is created. |
| transaction.processed | Every time a transaction is processed. |
| transaction.updated | Every time a transaction is updated. |
| transfer.batch.awaiting_approval | Transfer batch awaiting release. |
| transfer.batch.db.created | Transfer batch created. |
| transfer.batch.db.deleted | Transfer batch deleted. |
| transfer.batch.db.updated | Transfer batch updated. |
| transfer.cancel.confirmed (discontinued) | Every time a transfer cancellation is confirmed. |
| transfer.cancel.error (discontinued) | Every time an error occurs in transfer cancellation. |
| transfer.cancel.failed (discontinued) | Every time a transfer cancellation fails. |
| transfer.cancel.requested (discontinued) | Every time a transfer cancellation is requested. |
| transfer.db.created | Every time a transfer is created in the database. |
| transfer.db.deleted | Every time a transfer is deleted from the database. |
| transfer.db.updated | Every time a transfer is updated in the database. |
| transfer.register.confirmed (discontinued) | Every time a transfer registration at the financial institution is confirmed. |
| transfer.register.error (discontinued) | Every time an error occurs in transfer registration at the financial institution. |
| transfer.register.failed (discontinued) | Every time a transfer registration at the financial institution fails. |
| transfer.register.requested (discontinued) | Every time a transfer registration at the financial institution is requested. |
| transfer.reschedule.confirmed (discontinued) | Every time a transfer rescheduling is confirmed. |
| transfer.reschedule.error (discontinued) | Every time an error occurs in transfer rescheduling. |
| transfer.reschedule.failed (discontinued) | Every time a transfer rescheduling fails. |
| transfer.reschedule.requested (discontinued) | Every time a transfer rescheduling is requested. |
| transfer.transfer_batch.approve.confirmed (discontinued) | Every time a transfer batch approval at the financial institution is confirmed. |
| transfer.transfer_batch.approve.error (discontinued) | Every time an error occurs in transfer batch approval at the financial institution. |
| transfer.transfer_batch.approve.failed (discontinued) | Every time a transfer batch approval at the financial institution fails. |
| transfer.transfer_batch.approve.requested (discontinued) | Every time a transfer batch approval at the financial institution is requested. |
| transfer.transfer_batch.awaiting_approval (discontinued) | Every time the financial institution requests approval or rejection of a transfer batch. |
| transfer.transfer_batch.db.created (discontinued) | Every time a transfer batch is created in the database. |
| transfer.transfer_batch.db.deleted (discontinued) | Every time a transfer batch is deleted from the database. |
| transfer.transfer_batch.db.updated (discontinued) | Every time a transfer batch is updated in the database. |
| transfer.transfer_batch.register.confirmed (discontinued) | Every time a transfer batch registration at the financial institution is confirmed. |
| transfer.transfer_batch.register.error (discontinued) | Every time an error occurs in transfer batch registration at the financial institution. |
| transfer.transfer_batch.register.failed (discontinued) | Every time a transfer batch registration at the financial institution fails. |
| transfer.transfer_batch.register.requested (discontinued) | Every time a transfer batch registration at the financial institution is requested. |
| transfer.transfer_batch.reprove.confirmed (discontinued) | Every time a transfer batch rejection at the financial institution is confirmed. |
| transfer.transfer_batch.reprove.error (discontinued) | Every time an error occurs in transfer batch rejection at the financial institution. |
| transfer.transfer_batch.reprove.failed (discontinued) | Every time a transfer batch rejection at the financial institution fails. |
| transfer.transfer_batch.reprove.requested (discontinued) | Every time a transfer batch rejection at the financial institution is requested. |
| user.created | Every time a user is created. |
| user.deleted | Every time a user is deleted. |
| user.updated | Every time a user is updated. |
| webhook.db.created | Webhook created. |
| webhook.db.deleted | Webhook deleted. |
| webhook.db.updated | Webhook updated. |
| withdrawal.requested | Every time a withdrawal is requested. |
| withdrawal.transferred | Every time a withdrawal is transferred. |
Payment and Transfer Events by Type
In addition to the events listed above, the system generates specific events by payment and transfer type. These events follow a combinatorial structure and do not appear individually in the list.
| Code | Description |
|---|---|
| payment.{type}.{operation}.{status} | Payment events by type. Type: pix, bank_billet, darf, tax, utility, gru. Operation: register, approve, reschedule, cancel. Status: requested, confirmed, failed, error. Example: payment.pix.cancel.confirmed |
| payment.{type}_batch.{operation}.{status} | Payment batch events by type. Type: pix_batch, bank_billet_batch, darf_batch, tax_batch, utility_batch, gru_batch. Operation: register, approve, reprove. Also: awaiting_approval |
| transfer.{type}.{operation}.{status} | Transfer events by type. Type: ted, pix, internal. Operation: register, reschedule, approve, cancel. Status: requested, confirmed, failed, error. Example: transfer.ted.register.confirmed |
| transfer.{type}_batch.{operation}.{status} | Transfer batch events by type. Type: pix_batch, ted_batch, internal_batch. Operation: register, approve, reprove. Also: awaiting_approval |
Ping Event
The ping event is a special event to test whether the webhook URL is working. When a webhook is created, a notification is also created with the ping event.
Wildcard Events
When configuring the webhook, it is possible to subscribe to the above events and wildcard events. Wildcard events are not events that happen within Kobana, they are only representations of a set of events to determine which notifications the webhook should receive.
| Code | Description |
|---|---|
| * | All events. If the webhook is configured for this event, it is no longer necessary to configure for any other event and your system will receive notification for all events that occur in Kobana. Additionally, the webhook will be configured to receive any and all events that may be implemented later. |
| access_token.* | All events related to access tokens, including new events that are implemented after the webhook is created. |
| account.* | All events related to account, including new events that are implemented after the webhook is created. |
| bank_billet.* | All events related to bank boleto, including new events that are implemented after the webhook is created. |
| bank_billet_account.* | All events related to collection portfolios, including new events that are implemented after the webhook is created. |
| bank_billet_discharge.* | All events related to return records, including new events that are implemented after the webhook is created. |
| bank_billet_payment.* | All events related to boleto payment receipt, including new events that are implemented after the webhook is created. |
| bank_billet_registration.* | All events related to boleto registration via bank API, including new events that are implemented after the webhook is created. |
| bank_billet_remittance.* | All events related to remittance records, including new events that are implemented after the webhook is created. |
| charge.* | All events related to charging, including new events that are implemented after the webhook is created. |
| credit.* | All events related to credit restriction, including new events that are implemented after the webhook is created. |
| customer.* | All events related to customers, including new events that are implemented after the webhook is created. |
| customer_subscription.* | All events related to subscriptions, including new events that are implemented after the webhook is created. |
| data.* | All events related to data queries (boleto and Pix via QR Code), including new events that are implemented after the webhook is created. |
| discharge.* | All events related to returns, including new events that are implemented after the webhook is created. |
| edi.* | All events related to EDI, including new events that are implemented after the webhook is created. |
| email_account.* | All events related to email accounts, including new events that are implemented after the webhook is created. |
| enotas.* | All events related to fiscal notes (eNotas), including new events that are implemented after the webhook is created. |
| export.* | All events related to exports, including new events that are implemented after the webhook is created. |
| import.* | All events related to imports, including new events that are implemented after the webhook is created. |
| installment.* | All events related to installment plans, including new events that are implemented after the webhook is created. |
| integration.* | All events related to integrations and connections, including new events that are implemented after the webhook is created. |
| mailbox.* | All events related to mailbox, including new events that are implemented after the webhook is created. |
| payment.* | All events related to payments and their batches, including new events that are implemented after the webhook is created. |
| pix.* | All events related to Pix, including new events that are implemented after the webhook is created. |
| plan_subscription.* | All events related to plans, including new events that are implemented after the webhook is created. |
| remittance.* | All events related to remittances, including new events that are implemented after the webhook is created. |
| transaction.* | All events related to transactions, including new events that are implemented after the webhook is created. |
| transfer.* | All events related to transfers and their batches, including new events that are implemented after the webhook is created. |
| user.* | All events related to users, including new events that are implemented after the webhook is created. |
| webhook.* | All events related to webhooks, including new events that are implemented after the webhook is created. |
| withdrawal.* | All events related to withdrawals, including new events that are implemented after the webhook is created. |