Alguns eventos que ocorrem dentro da Kobana são registrados. Todos eles, quando registrados, geram notificações para cada webhook que esteja ativo e configurado para receber o respectivo evento.
Você pode acessar a qualquer momento o Log de Eventos da sua conta.
Os códigos dos eventos seguem um padrão resource.event, onde resource é o nome do recurso que gerou o evento e event é a ação propriamente dita.
Lista de eventos
| Código | Descrição |
|---|---|
| account.bank_billet_creation_blocked | Toda vez que a emissão de boleto é bloqueada. |
| account.blocked | Toda vez que a conta é bloqueada. |
| account.updated | Toda vez que a conta é atualizada. |
| addon.activated | Toda vez que um add-on é ativado. |
| addon.removed | Toda vez que um add-on é removido. |
| bank_billet.blocked | Toda vez que o pagamento de um boleto é bloqueado. |
| bank_billet.cancel.confirmed | Toda vez que o cancelamento do boleto é confirmado. |
| bank_billet.cancel.error | Toda vez que ocorrer um erro no cancelamento do boleto. |
| bank_billet.cancel.failed | Toda vez que o cancelamento do boleto tem uma falha definitiva. |
| bank_billet.cancel.requested | Toda vez que o cancelamento do boleto é solicitado. |
| bank_billet.canceled | Toda vez que um boleto é cancelado. |
| bank_billet.created | Toda vez que um boleto é criado. |
| bank_billet.deleted | Toda vez que um boleto é excluído. |
| bank_billet.due_date (descontinuado) | Toda vez que um boleto é notificado com X dias antes do vencimento. |
| bank_billet.generated | Toda vez que o PDF de um boleto é gerado. |
| bank_billet.overdue | Toda vez que um boleto fica vencido. |
| bank_billet.paid | Toda vez que um boleto é pago. |
| bank_billet.register.confirmed | Toda vez que o registro do boleto é confirmado. |
| bank_billet.register.error | Toda vez que ocorrer um erro no registro do boleto. |
| bank_billet.register.failed | Toda vez que o registro do boleto tem uma falha definitiva. |
| bank_billet.register.requested | Toda vez que o registro do boleto é solicitado. |
| bank_billet.registered | Toda vez que um boleto é registrado no banco. |
| bank_billet.rejected | Toda vez que um boleto é rejeitado pelo banco. |
| bank_billet.update.confirmed | Toda vez que uma atualização do boleto é confirmada. |
| bank_billet.update.error | Toda vez que ocorrer um erro na atualização do boleto. |
| bank_billet.update.failed | Toda vez que uma atualização do boleto tem uma falha definitiva. |
| bank_billet.update.requested | Toda vez que uma atualização do boleto é solicitada. |
| bank_billet.updated | Toda vez que um boleto é atualizado. |
| bank_billet.sync.requested | Toda vez que uma sincronização de boleto é solicitada. |
| bank_billet.sync.confirmed | Toda vez que uma sincronização de boleto é confirmada. |
| bank_billet.sync.failed | Toda vez que há uma falha na sincronização de boleto. |
| bank_billet.sync.error | Toda vez que ocorrer um erro na sincronização de boleto. |
| bank_billet_account.activated | Toda vez que uma carteira de cobrança é ativada. |
| bank_billet_account.created | Toda vez que uma carteira de cobrança é criada. |
| bank_billet_account.deleted | Toda vez que uma carteira de cobrança é excluída. |
| bank_billet_account.homologated (descontinuado) | Toda vez que uma carteira de cobrança é homologada. |
| bank_billet_account.homologation_started | Toda vez que uma carteira de cobrança é enviada para homologação. |
| bank_billet_account.updated | Toda vez que uma carteira de cobrança é atualizada. |
| bank_billet_account.validated (descontinuado) | Toda vez que uma carteira de cobrança é validada. |
| bank_billet_account.validation_released | Toda vez que uma carteira de cobrança é enviada para validação. |
| bank_billet_discharge.created | Toda vez que um registro de retorno é criado. |
| bank_billet_discharge.deleted | Toda vez que um registro de retorno é excluído. |
| bank_billet_discharge.updated | Toda vez que um registro de retorno é atualizado. |
| bank_billet_payment.created | Toda vez que um pagamento é criado. |
| bank_billet_payment.deleted | Toda vez que um pagamento é excluído. |
| bank_billet_payment.updated | Toda vez que um pagamento é atualizado. |
| bank_billet_registration.created | Toda vez que um registro de boleto é criado. |
| bank_billet_registration.deleted | Toda vez que um registro de boleto é excluído. |
| bank_billet_registration.updated | Toda vez que um registro de boleto é atualizado. |
| bank_billet_remittance.created | Toda vez que um registro de remessa é criado. |
| bank_billet_remittance.deleted | Toda vez que um registro de remessa é excluído. |
| bank_billet_remittance.updated | Toda vez que um registro de remessa é atualizado. |
| charge.payment.db.created | Toda vez que um recebimento é criado no banco de dados. |
| charge.payment.db.deleted | Toda vez que um recebimento é excluído no banco de dados. |
| charge.payment.db.updated | Toda vez que um recebimento é atualizado no banco de dados. |
| credit.restriction.add.confirmed | Toda vez que um inclusão da restrição de crédito é confirmada. |
| credit.restriction.add.error | Toda vez que ocorrer um erro na inclusão da restrição de crédito. |
| credit.restriction.add.failed | Toda vez que um inclusão da restrição de crédito falha. |
| credit.restriction.add.requested | Toda vez que um inclusão da restrição de crédito é solicitada. |
| credit.restriction.remove.confirmed | Toda vez que uma remoção da restrição de crédito é confirmada. |
| credit.restriction.remove.error | Toda vez que ocorrer um erro na remoção da restrição de crédito. |
| credit.restriction.remove.failed | Toda vez que uma remoção da restrição de crédito falha. |
| credit.restriction.remove.requested | Toda vez que uma remoção da restrição de crédito é solicitada. |
| customer.created | Toda vez que um cliente é criado. |
| customer.deleted | Toda vez que um cliente é excluído. |
| customer.portal_password_updated | Toda vez que a senha do portal do cliente é atualizada. |
| customer.updated | Toda vez que um cliente é atualizado. |
| customer_subscription.created | Toda vez que uma assinatura é criada. |
| customer_subscription.deleted | Toda vez que uma assinatura é excluída. |
| customer_subscription.updated | Toda vez que uma assinatura é atualizada. |
| discharge.created | Toda vez que um retorno é criado. |
| discharge.deleted | Toda vez que um retorno é excluído. |
| discharge.processed | Toda vez que um retorno é processado. |
| edi.edi_box.activated | Toda vez que um EDI é ativado. |
| edi.edi_box.db.created | Toda vez que um EDI é criado. |
| edi.edi_box.db.deleted | Toda vez que um EDI é excluído. |
| edi.edi_box.db.updated | Toda vez que um EDI é atualizado. |
| financial.account.balance.updated | Toda vez que um saldo de uma conta financeira é atualizado. |
| financial.account.balance_sync.confirmed | Toda vez que uma sincronização de um saldo de uma conta financeira é confirmada. |
| financial.account.balance_sync.error | Toda vez que ocorrer um erro na sincronização de um saldo de uma conta financeira. |
| financial.account.balance_sync.failed | Toda vez que uma sincronização de um saldo de uma conta financeira falha. |
| financial.account.balance_sync.requested | Toda vez que uma sincronização de um saldo de uma conta financeira é solicitada. |
| financial.account.statement.updated | Toda vez que um extrato é atualizado. (Seja por importação do CNAB ou sincronização com api do banco) |
| financial.account.statement_sync.confirmed | Toda vez que uma sincronização do extrato é confirmada. |
| financial.account.statement_sync.error | Toda vez que ocorrer um erro na sincronização do extrato. |
| financial.account.statement_sync.failed | Toda vez que uma sincronização do extrato falha. |
| financial.account.statement_sync.requested | Toda vez que uma sincronização do extrato é solicitada. |
| import.created | Toda vez que uma importação é criada. |
| import.deleted | Toda vez que uma importação é excluída. |
| import.processed | Toda vez que uma importação é processada. |
| installment.created | Toda vez que um carnê é criado. |
| installment.deleted | Toda vez que um carnê é excluído. |
| installment.generated | Toda vez que todas as parcelas de um carnê são geradas. |
| installment.processed | Toda vez que todas as parcelas de um carnê são processadas. |
| payment.cancel.confirmed | Toda vez que um cancelamento de um pagamento é confirmado. |
| payment.cancel.error | Toda vez que ocorrer um erro no cancelamento de um pagamento. |
| payment.cancel.failed | Toda vez que um cancelamento de um pagamento falha. |
| payment.cancel.requested | Toda vez que um cancelamento de um pagamento é solicitado. |
| payment.db.created | Toda vez que um pagamento é criado no banco de dados. |
| payment.db.deleted | Toda vez que um pagamento é excluído no banco de dados. |
| payment.db.updated | Toda vez que um pagamento é atualizado no banco de dados. |
| payment.payment_batch.approve.confirmed | Toda vez que a aprovação de um Lote de pagamento na instituição financeira é confirmada. |
| payment.payment_batch.approve.error | Toda vez que ocorrer um erro na aprovação de um lote de pagamento na instituição financeira. |
| payment.payment_batch.approve.failed | Toda vez que a aprovação de um Lote de pagamento na instituição financeira falha. |
| payment.payment_batch.approve.requested | Toda vez que a aprovação de um Lote de pagamento na instituição financeira é solicitada. |
| payment.payment_batch.awaiting_approval | Toda vez que a instituição financeira solicita aprovação ou rejeição de um Lote de pagamento. |
| payment.payment_batch.db.created | Toda vez que um Lote de pagamento é criado no banco de dados. |
| payment.payment_batch.db.deleted | Toda vez que um Lote de pagamento é excluído no banco de dados. |
| payment.payment_batch.db.updated | Toda vez que um Lote de pagamento é atualizado no banco de dados. |
| payment.payment_batch.register.confirmed | Toda vez que o registro de um Lote de pagamento na instituição financeira é confirmado. |
| payment.payment_batch.register.error | Toda vez que ocorrer um erro no registro de um lote de pagamento na instituição financeira. |
| payment.payment_batch.register.failed | Toda vez que o registro de um Lote de pagamento na instituição financeira falha. |
| payment.payment_batch.register.requested | Toda vez que o registro de um Lote de pagamento na instituição financeira é solicitado. |
| payment.payment_batch.reprove.confirmed | Toda vez que a rejeição de um Lote de pagamento na instituição financeira é confirmada. |
| payment.payment_batch.reprove.error | Toda vez que ocorrer um erro na rejeição de um lote de pagamento na instituição financeira. |
| payment.payment_batch.reprove.failed | Toda vez que a rejeição de um Lote de pagamento na instituição financeira falha. |
| payment.payment_batch.reprove.requested | Toda vez que a rejeição de um Lote de pagamento na instituição financeira é solicitada. |
| payment.register.confirmed | Toda vez que o registro de um pagamento na instituição financeira é confirmado. |
| payment.register.error | Toda vez que ocorrer um erro no registro de um pagamento na instituição financeira. |
| payment.register.failed | Toda vez que o registro de um pagamento na instituição financeira falha. |
| payment.register.requested | Toda vez que o registro de um pagamento na instituição financeira é solicitado. |
| ping | Evento especial para testar o webhook. |
| pix.cancel.confirmed | Toda vez que um cancelamento de um Pix é confirmado. |
| pix.cancel.error | Toda vez que ocorrer um erro no cancelamento do Pix. |
| pix.cancel.failed | Toda vez que um cancelamento de um Pix tem uma falha definitiva. |
| pix.cancel.requested | Toda vez que um cancelamento de um Pix é solicitado. |
| pix.db.created | Toda vez que um Pix é criado no banco de dados. |
| pix.db.deleted | Toda vez que um Pix é excluído no banco de dados. |
| pix.db.updated | Toda vez que um Pix é atualizado no banco de dados. |
| pix.paid | Toda vez que a confirmação do pagamento de um Pix é recebida. |
| pix.overdue | Toda vez que um Pix Cobrança é vencido. |
| pix.register.confirmed | Toda vez que o registro de um Pix é confirmado. |
| pix.register.error | Toda vez que ocorrer um erro no registro do Pix. |
| pix.register.failed | Toda vez que o registro de um Pix tem uma falha definitiva. |
| pix.register.requested | Toda vez que o registro de um Pix é solicitado. |
| pix.update.confirmed | Toda vez que uma atualização do Pix é confirmada. |
| pix.update.error | Toda vez que ocorrer um erro na atualização do Pix. |
| pix.update.failed | Toda vez que uma atualização do Pix tem uma falha definitiva. |
| pix.update.requested | Toda vez que uma atualização do Pix é solicitada. |
| plan_subscription.activated | Toda vez que um plano é ativado. |
| plan_subscription.fee | Toda vez que um plano é cobrado. |
| plan_subscription.removed | Toda vez que um plano é desativado. |
| plan_subscription.updated | Toda vez que um plano é atualizado. |
| remittance.created | Toda vez que uma remessa é criada. |
| remittance.deleted | Toda vez que uma remessa é excluída. |
| remittance.downloaded | Toda vez que uma remessa é baixada. |
| remittance.processed | Toda vez que uma remessa é processada. |
| remittance.line.db.created | Toda vez que uma linha de remessa é criada. |
| remittance.line.db.deleted | Toda vez que uma linha de remessa é excluída. |
| remittance.line.db.updated | Toda vez que uma linha de remessa é atualizada. |
| remittance.sent | Toda vez que uma remessa é enviada. (Somente quando contratado envio automático) |
| transaction.created | Toda vez que uma transação é criada. |
| transaction.processed | Toda vez que uma transação é processada. |
| transaction.updated | Toda vez que uma transação é atualizada. |
| transfer.cancel.confirmed | Toda vez que um cancelamento de uma transferência é confirmado. |
| transfer.cancel.error | Toda vez que ocorrer um erro no cancelamento de uma transferência. |
| transfer.cancel.failed | Toda vez que um cancelamento de uma transferência falha. |
| transfer.cancel.requested | Toda vez que um cancelamento de uma transferência é solicitado. |
| transfer.db.created | Toda vez que uma transferência é criada no banco de dados. |
| transfer.db.deleted | Toda vez que uma transferência é excluída no banco de dados. |
| transfer.db.updated | Toda vez que uma transferência é atualizada no banco de dados. |
| transfer.register.confirmed | Toda vez que o registro de uma transferência na instituição financeira é confirmado. |
| transfer.register.error | Toda vez que ocorrer um erro no registro de uma transferência na instituição financeira. |
| transfer.register.failed | Toda vez que o registro de uma transferência na instituição financeira falha. |
| transfer.register.requested | Toda vez que o registro de uma transferência na instituição financeira é solicitado. |
| transfer.reschedule.confirmed | Toda vez que um reagendamento de uma transferência é confirmado. |
| transfer.reschedule.error | Toda vez que ocorrer um erro no reagendamento de uma transferência. |
| transfer.reschedule.failed | Toda vez que um reagendamento de uma transferência falha. |
| transfer.reschedule.requested | Toda vez que um reagendamento de uma transferência é solicitado. |
| transfer.transfer_batch.approve.confirmed | Toda vez que a aprovação de um Lote de transferência na instituição financeira é confirmada. |
| transfer.transfer_batch.approve.error | Toda vez que ocorrer um erro na aprovação de um lote de transferência na instituição financeira. |
| transfer.transfer_batch.approve.failed | Toda vez que a aprovação de um Lote de transferência na instituição financeira falha. |
| transfer.transfer_batch.approve.requested | Toda vez que a aprovação de um Lote de transferência na instituição financeira é solicitada. |
| transfer.transfer_batch.awaiting_approval | Toda vez que a instituição financeira solicita aprovação ou rejeição de um Lote de transferência. |
| transfer.transfer_batch.db.created | Toda vez que um Lote de transferência é criado no banco de dados. |
| transfer.transfer_batch.db.deleted | Toda vez que um Lote de transferência é excluído no banco de dados. |
| transfer.transfer_batch.db.updated | Toda vez que um Lote de transferência é atualizado no banco de dados. |
| transfer.transfer_batch.register.confirmed | Toda vez que o registro de um Lote de transferência na instituição financeira é confirmado. |
| transfer.transfer_batch.register.error | Toda vez que ocorrer um erro no registro de um lote de transferência na instituição financeira. |
| transfer.transfer_batch.register.failed | Toda vez que o registro de um Lote de transferência na instituição financeira falha. |
| transfer.transfer_batch.register.requested | Toda vez que o registro de um Lote de transferência na instituição financeira é solicitado. |
| transfer.transfer_batch.reprove.confirmed | Toda vez que a rejeição de um Lote de transferência na instituição financeira é confirmada. |
| transfer.transfer_batch.reprove.error | Toda vez que ocorrer um erro na rejeição de um lote de transferência na instituição financeira. |
| transfer.transfer_batch.reprove.failed | Toda vez que a rejeição de um Lote de transferência na instituição financeira falha. |
| transfer.transfer_batch.reprove.requested | Toda vez que a rejeição de um Lote de transferência na instituição financeira é solicitada. |
| user.created | Toda vez que um usuário é criado. |
| user.deleted | Toda vez que um usuário é excluído. |
| user.updated | Toda vez que um usuário é atualizado. |
| withdrawal.requested | Toda vez que um saque é solicitado. |
| withdrawal.transferred | Toda vez que um saque é transferido. |
| charge.bank_billet.payment.notified | Toda vez que um pagamento de boleto é notificado pela instituição financeira. |
| charge.bank_billet.payment.confirmed | Toda vez que um pagamento de boleto é efetivado na instituição financeira. |
| charge.bank_billet.payment.canceled | Toda vez que um pagamento de boleto é cancelado na instituição financeira. |
Evento Ping
O evento ping é um evento especial para testar se a URL do webhook está funcionando. Quando um webhook é criado uma notificação também é criado com o evento ping.
Eventos Coringas
Ao configurar o webhook é possível se inscrever nos eventos acima e nos eventos coringas. Eventos coringas não são eventos que acontecem dentro do Kobana, eles são apenas representações de um conjunto de eventos para determinar que notificações o webhook deve receber.
| Código | Descrição |
|---|---|
| - | Todos os eventos. Se o webhook estiver configurado para este evento, não é mais necessário configurar para nenhum outro evento e o seu sistema receberá notificação para todos os eventos que ocorrerem na Kobana. Além disso, o webhook estará configurado para receber todo e qualquer evento que venha ser implementado posteriormente. |
| account.* | Todos os eventos relacionados a conta, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| addon.* | Todos os eventos relacionados a addon, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet.* | Todos os eventos relacionados a boleto bancário, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet_account.* | Todos os eventos relacionados a carteiras de cobrança, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet_discharge.* | Todos os eventos relacionados a registros de retornos, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet_payment.* | Todos os eventos relacionados a recebimento de boleto, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet_registration.* | Todos os eventos relacionados a registro de boleto por API bancária, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| bank_billet_remittance.* | Todos os eventos relacionados a registros de remessa, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| charge.* | Todos os eventos relacionados a cobrança, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| credit.* | Todos os eventos relacionados a restrição de crédito, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| customer.* | Todos os eventos relacionados a clientes, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| customer_subscription.* | Todos os eventos relacionados a assinaturas, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| discharge.* | Todos os eventos relacionados a retornos, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| edi_box.* | Todos os eventos relacionados a EDI, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| financial.* | Todos os eventos relacionados a conta financeira, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| import.* | Todos os eventos relacionados a importação, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| installment.* | Todos os eventos relacionados a carnês, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| payment.* | Todos os eventos relacionados a pagamentos e seus lotes, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| pix.* | Todos os eventos relacionados a Pix, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| plan_subscription.* | Todos os eventos relacionados a planos, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| remittance.* | Todos os eventos relacionados a remessas, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| transaction.* | Todos os eventos relacionados a transações, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| transfer.* | Todos os eventos relacionados a transferências e seus lotes, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| user.* | Todos os eventos relacionados a usuário, inclusive os novos eventos que sejam implementados após a criação do webhook. |
| withdrawal.* | Todos os eventos relacionados a saques, inclusive os novos eventos que sejam implementados após a criação do webhook. |