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.updated | Toda vez que a conta é atualizada. |
| account.blocked | Toda vez que a conta é bloqueada. |
| bank_billet.created | Toda vez que um boleto é criado. |
| bank_billet.generated | Toda vez que o PDF de um boleto é gerado. |
| bank_billet.updated | Toda vez que um boleto é atualizado. |
| bank_billet.canceled | Toda vez que um boleto é cancelado. |
| bank_billet.overdue | Toda vez que um boleto fica vencido. |
| bank_billet.paid | Toda vez que um boleto é pago. |
| bank_billet.blocked | Toda vez que o pagamento de um boleto é bloqueado. |
| bank_billet.rejected | Toda vez que um boleto é rejeitado pelo banco. |
| bank_billet.registered | Toda vez que um boleto é registrado no banco. |
| bank_billet.due_date | Toda vez que um boleto é notificado com X dias antes do vencimento. |
| bank_billet.deleted | Toda vez que um boleto é excluído. |
| bank_billet.cancel.requested | Toda vez que o cancelamento do boleto é solicitado. |
| bank_billet.cancel.confirmed | Toda vez que o cancelamento do boleto é confirmado. |
| bank_billet.cancel.failed | Toda vez que o cancelamento do boleto falha. |
| bank_billet.register.requested | Toda vez que o registro do boleto é solicitado. |
| bank_billet.register.confirmed | Toda vez que o registro do boleto é confirmado. |
| bank_billet.register.failed | Toda vez que o registro do boleto falha. |
| bank_billet_account.created | Toda vez que uma carteira de cobrança é criada. |
| bank_billet_account.homologation_started | Toda vez que uma carteira de cobrança é enviada para homologação. |
| bank_billet_account.validation_released | Toda vez que uma carteira de cobrança é enviada para validação. |
| bank_billet_account.activated | Toda vez que uma carteira de cobrança é homologada. |
| bank_billet_account.updated | Toda vez que uma carteira de cobrança é atualizada. |
| bank_billet_account.deleted | Toda vez que uma carteira de cobrança é excluída. |
| bank_billet_discharge.created | Toda vez que um registro de retorno é criado. |
| bank_billet_discharge.updated | Toda vez que um registro de retorno é atualizado. |
| bank_billet_discharge.deleted | Toda vez que um registro de retorno é excluído. |
| bank_billet_payment.created | Toda vez que um pagamento é criado. |
| bank_billet_payment.updated | Toda vez que um pagamento é atualizado. |
| bank_billet_payment.deleted | Toda vez que um pagamento é excluído. |
| bank_billet_remittance.created | Toda vez que um registro de remessa é criado. |
| bank_billet_remittance.updated | Toda vez que um registro de remessa é atualizado. |
| bank_billet_remittance.deleted | Toda vez que um registro de remessa é excluído. |
| bank_billet_registration.created | Toda vez que um registro de boleto é criado. |
| bank_billet_registration.updated | Toda vez que um registro de boleto é atualizado. |
| bank_billet_registration.deleted | Toda vez que um registro de boleto é excluído. |
| customer.created | Toda vez que um cliente é criado. |
| customer.updated | Toda vez que um cliente é atualizado. |
| customer.portal_password_updated | Toda vez que a senha do portal do cliente atualizada. |
| customer.deleted | Toda vez que um cliente é excluído. |
| customer_subscription.created | Toda vez que uma assinatura é criada. |
| customer_subscription.updated | Toda vez que uma assinatura é atualizada. |
| customer_subscription.deleted | Toda vez que uma assinatura é excluída. |
| discharge.created | Toda vez que um retorno é criado. |
| discharge.processed | Toda vez que um retorno é processado. |
| discharge.deleted | Toda vez que um retorno é excluído. |
| installment.created | Toda vez que um carnê é criado. |
| installment.processed | Toda vez que todas as parcelas de um carnê são criadas. |
| installment.generated | Toda vez que todas as parcelas de um carnê são geradas. |
| installment.deleted | Toda vez que um carnê é apagado. |
| import.created | Toda vez que uma importação é criada. |
| import.processed | Toda vez que uma importação é processada. |
| import.deleted | Toda vez que uma importação é excluída. |
| plan_subscription.activated | Toda vez que um plano é ativado. |
| plan_subscription.removed | Toda vez que um plano é desativado. |
| plan_subscription.fee | Toda vez que um plano é cobrado. |
| plan_subscription.updated | Toda vez que um plano é atualizado. |
| ping | Evento especial para testar o webhook. |
| pix.db.created | Toda vez que um Pix é criado no banco de dados. |
| pix.db.updated | Toda vez que um Pix é atualizado no banco de dados. |
| pix.db.deleted | Toda vez que um Pix é excluído no banco de dados. |
| pix.update.requested | Toda vez que uma atualização do Pix é solicitada. |
| pix.update.confirmed | Toda vez que uma atualização do Pix é confirmada. |
| pix.update.failed | Toda vez que uma atualização do Pix falha. |
| pix.register.requested | Toda vez que o registro de um Pix na Instituição Financeira é solicitado. |
| pix.register.confirmed | Toda vez que o registro de um Pix na Instituição Financeira é confirmado. |
| pix.register.failed | Toda vez que o registro de um Pix na Instituição Financeira falha. |
| pix.cancel.requested | Toda vez que um cancelamento de um Pix na Instituição Financeira é solicitado. |
| pix.cancel.confirmed | Toda vez que um cancelamento de um Pix na Instituição Financeira é confirmado. |
| pix.cancel.failed | Toda vez que um cancelamento de um Pix na Instituição Financeira falha. |
| pix.paid | Toda vez que a confirmação do pagamento de um Pix é recebida. |
| remittance.created | Toda vez que uma remessa é criada. |
| remittance.processed | Toda vez que uma remessa é processada. |
| remittance.downloaded | Toda vez que uma remessa é baixada. |
| remittance.sent | Toda vez que uma remessa é enviada. (Somente quando contratado envio automático) |
| remittance.deleted | Toda vez que uma remessa é excluída. |
| transaction.created | Toda vez que uma transação é criada. |
| transaction.updated | Toda vez que uma transação é atualizada. |
| transaction.processed | Toda vez que uma transação é processada. |
| withdrawal.transferred | Toda vez que um saque é transferido. |
| withdrawal.requested | Toda vez que um saque é solicitado. |
| user.created | Toda vez que um usuário é criado. |
| user.updated | Toda vez que um usuário é atualizado. |
| user.deleted | Toda vez que um usuário é excluído. |
| addon.activated | Toda vez que um add-on é ativado. |
| addon.removed | Toda vez que um add-on é removido. |
| edi.activated | Toda vez que um EDI é ativado. |
| financial.account.balance.updated | Toda vez que um saldo de uma conta financeira é atualizado. |
| financial.account.statement_sync.requested | Toda vez que uma sincronização do extrato é solicitada. |
| financial.account.statement_sync.confirmed | Toda vez que uma sincronização do extrato é confirmada. |
| financial.account.statement_sync.failed | Toda vez que uma sincronização do extrato falha. |
| financial.account.statement.updated | Toda vez que um extrato é atualizado.(Seja por importação do CNAB ou sincronização com api do banco) |
| financial.transfer.db.created | Toda vez que uma Transferência é criada no banco de dados. |
| financial.transfer.db.updated | Toda vez que uma Transferência é atualizada no banco de dados. |
| financial.transfer.db.deleted | Toda vez que uma Transferência é excluída no banco de dados. |
| financial.transfer.register.requested | Toda vez que o registro de uma Transferência na Instituição Financeira é solicitado. |
| financial.transfer.register.confirmed | Toda vez que o registro de uma Transferência na Instituição Financeira é confirmado. |
| financial.transfer.register.failed | Toda vez que o registro de uma Transferência na Instituição Financeira falha. |
| financial.transfer_batch.db.created | Toda vez que um Lote de Transferência é criado no banco de dados. |
| financial.transfer_batch.db.updated | Toda vez que um Lote de Transferência é atualizado no banco de dados. |
| financial.transfer_batch.db.deleted | Toda vez que um Lote de Transferência é excluído no banco de dados. |
| financial.transfer_batch.awaiting_approval | Toda vez que a Instituição Financeira solicita aprovação ou rejeição de um Lote de Transferência. |
| financial.transfer_batch.register.requested | Toda vez que o registro de um Lote de Transferência na Instituição Financeira é solicitado. |
| financial.transfer_batch.register.confirmed | Toda vez que o registro de um Lote de Transferência na Instituição Financeira é confirmado. |
| financial.transfer_batch.register.failed | Toda vez que o registro de um Lote de Transferência na Instituição Financeira falha. |
| financial.transfer_batch.approve.requested | Toda vez que a aprovação de um Lote de Transferência na Instituição Financeira é solicitada. |
| financial.transfer_batch.approve.confirmed | Toda vez que a aprovação de um Lote de Transferência na Instituição Financeira é confirmada. |
| financial.transfer_batch.approve.failed | Toda vez que a aprovação de um Lote de Transferência na Instituição Financeira falha. |
| financial.transfer_batch.reprove.requested | Toda vez que a rejeição de um Lote de Transferência na Instituição Financeira é solicitada. |
| financial.transfer_batch.reprove.confirmed | Toda vez que a rejeição de um Lote de Transferência na Instituição Financeira é confirmada. |
| financial.transfer_batch.reprove.failed | Toda vez que a rejeição de um Lote de Transferência na Instituição Financeira falha. |
| credit.restriction.add.requested | Toda vez que um inclusão da restrição de crédito é solicitada. |
| credit.restriction.add.confirmed | Toda vez que um inclusão da restrição de crédito é confirmada. |
| credit.restriction.add.failed | Toda vez que um inclusã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. |
| credit.restriction.remove.confirmed | Toda vez que uma remoção da restrição de crédito é confirmada. |
| credit.restriction.remove.failed | Toda vez que uma remoção da restrição de crédito falha. |
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. |
| 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_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_remittance.* | Todos os eventos relacionados a registros de remessa, 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. |
| transaction.* | Todos os eventos relacionados a transações, 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. |
| user.* | Todos os eventos relacionados a usuário, 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. |
| discharge.* | Todos os eventos relacionados a retornos, 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. |
| 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. |
| installment.* | Todos os eventos relacionados a carnês, 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. |
| edi.* | Todos os eventos relacionados a EDI, inclusive os novos eventos que sejam implementados após a criação do webhook. |