Pular para o conteúdo principal

Tipos de eventos

Está é uma lista dos diversos tipos de eventos que estamos enviando no momento. É importante destacar que essa lista pode ser expandida a qualquer momento, então, durante o processo de desenvolvimento do seu código, é recomendado não assumir que esses são os únicos tipos existentes.

Observe que esses eventos seguem um formato padrão: recurso.evento.

nota

Eventos que ocorrem em sub-recursos, como em installment.paid, não disparam eventos de atualização no recurso principal, como o loan.updated.

APITipo do eventoDescriçãoModelo
Employmentemployment.createdOcorre quando um novo vínculo empregatício é criado.Employment
Employmentemployment.deceasedOcorre quando um vínculo empregatício é marcado como falecido.Employment
Employmentemployment.terminatedOcorre quando um vínculo empregatício é encerrado.Employment
Employmentemployment.deletedOcorre quando um vínculo empregatício é deletado.Employment
Employmentemployment.transferredOcorre quando um vínculo empregatício é marcado como transferido.Employment
ApiKeyapi_key.createdOcorre quando uma nova chave API é criada.ApiKey
ApiKeyapi_key.updatedOcorre quando uma chave API é atualizada.ApiKey
Operatoroperator.createdOcorre quando um novo operador é criado.Operator
Operatoroperator.updatedOcorre quando um operador é atualizado.Operator
Operatoroperator.deletedOcorre quando um operador é excluído.Operator
Payment Intentpayment_intent.paidOcorre quando uma intenção de pagamento é efetuada.PaymentIntent
Payment Intentpayment_intent.voidedOcorre quando uma intenção de pagamento é anulada.PaymentIntent
Payment Intentpayment_intent.createdOcorre quando uma intenção de pagamento é criada.PaymentIntent
Invoiceinvoice.paidOcorre quando uma fatura é paga.Invoice
Invoiceinvoice.finalizedOcorre quando uma fatura é finalizada.Invoice
Invoiceinvoice.voidedOcorre quando uma fatura é anulada.Invoice
Invoiceinvoice.createdOcorre quando uma fatura é criada.Invoice
Invoiceinvoice.deletedOcorre quando uma fatura é deletada.Invoice
Invoiceinvoice.marked_uncollectibleOcorre quando uma fatura é marcada como incobrável.Invoice
Invoiceinvoice.updatedOcorre quando uma fatura é atualizada.Invoice
Invoiceinvoice.expiredOcorre quando uma fatura expirada é removida automaticamente do sistema.Invoice
Invoice Iteminvoice_item.createdOcorre quando um item de fatura é criado.Invoice-Item
Invoice Iteminvoice_item.deletedOcorre quando um item de fatura é deletado.Invoice-Item
Payment Methodpayment_method.createdOcorre quando um novo método de pagamento é criado.PaymentMethod
Payment Methodpayment_method.voidedOcorre quando um método de pagamento é anulado.PaymentMethod
Payment Methodpayment_method.linkedOcorre quando um método de pagamento é vinculado a uma conta.PaymentMethod
Payment Methodpayment_method.verifiedOcorre quando um método de pagamento é verificado.PaymentMethod
Installmentinstallment.paidOcorre quando uma parcela é paga.Installment
Installmentinstallment.unpaidOcorre quando uma parcela não é paga.Installment
Installmentinstallment.createdOcorre quando uma nova parcela é criada.Installment
Installmentinstallment.transaction.createdOcorre quando uma transação de parcela é criada.Installment
Installmentinstallment.voidedOcorre quando uma parcela é anulada.Installment
Installmentinstallment.conflictedOcorre quando há um conflito em uma parcela.Installment
Installmentinstallment.marked_uncollectibleOcorre quando uma parcela é marcada como incobrável.Installment
Companycompany.createdOcorre quando uma nova empresa é criada.Company
Companycompany.updatedOcorre quando uma empresa é atualizada.Company
Companycompany.deletedOcorre quando uma empresa é excluída.Company
Credit-Policycredit_policy.createdOcorre quando uma política de crédito é criada.Credit-policy
Credit-Policycredit_policy.updatedOcorre quando uma política de crédito é atualizada.Credit-policy
Credit-Policycredit_policy.deletedOcorre quando uma política de crédito é deletada.Credit-policy
Data-Entitydata_entity.createdOcorre quando uma entidade é criada.Data-entity
Data-Entitydata_entity.deletedOcorre quando uma entidade é deletada.Data-entity
Documentdocument.createdOcorre quando um documento é criado.Document
Documentdocument.updatedOcorre quando um documento é atualizado.Document
Documentdocument.deletedOcorre quando um documento é deletado.Document
Loanloan.createdOcorre quando um novo empréstimo é criado.Loan
Loanloan.updatedOcorre quando um empréstimo é atualizado.Loan
Loanloan.transaction.createdOcorre quando uma transação de empréstimo é criada.Loan
Loanloan.disbursedOcorre quando um empréstimo é liberado.Loan
Loanloan.canceledOcorre quando um empréstimo é cancelado.Loan
Loanloan.deletedOcorre quando um empréstimo é excluído.Loan
Loanloan.marked_disbursingOcorre quando um empréstimo é marcado para liberação.Loan
Loanloan.repaidOcorre quando um empréstimo é pago.Loan
Loanloan.expiredOcorre quando um empréstimo expira.Loan
Loanloan.marked_pendingOcorre quando um empréstimo é marcado como pendente.Loan
Loanloan.marked_openOcorre quando um empréstimo é marcado como aberto.Loan
Loanloan.voidedOcorre quando um empréstimo é anulado.Loan
Loanloan.signedOcorre quando um empréstimo é assinado.Loan
Loanloan.file_detachedOcorre quando um arquivo é desanexado.Loan
Customercustomer.createdOcorre quando um novo cliente é criado.Customer
Customercustomer.updatedOcorre quando um cliente é atualizado.Customer
Customercustomer.deletedOcorre quando um cliente é deletado.Customer
Customercustomer.file_attachedOcorre quando um arquivo do cliente é anexado.Customer
Customercustomer.file_detachedOcorre quando um arquivo do cliente é removido.Customer
Offeroffer.calculatedOcorre quando uma oferta é calculada.Offer
Offeroffer.createdOcorre quando uma nova oferta é criada.Offer
Filefile.verifiedOcorre quando um arquivo é verificado.File
Webhook eventwebhook.event.kobanaOcorre quando um evento de webhook é processado pelo Kobana.WebhookEvent
Operator Permissionoperator_permission.createdOcorre quando uma nova permissão de operador é criada.OperatorPermission
Operator Permissionoperator_permission.updatedOcorre quando uma permissão de operador é atualizada.OperatorPermission
Operator Permissionoperator_permission.deletedOcorre quando uma permissão de operador é excluída.OperatorPermission
Productproduct.createdOcorre quando um novo produto é criado.Product
Productproduct.updatedOcorre quando um produto é atualizado.Product
Productproduct.deletedOcorre quando um produto é excluído.Product
Company Groupcompany_group.createdOcorre quando um novo grupo de empresas é criado.CompanyGroup
Company Groupcompany_group.updatedOcorre quando um grupo de empresas é atualizado.CompanyGroup
Company Groupcompany_group.deletedOcorre quando um grupo de empresas é excluído.CompanyGroup
Fundfund.createdOcorre quando um novo fundo é criado.Fund
Fundfund.updatedOcorre quando um fundo é atualizado.Fund
Fundfund.deletedOcorre quando um fundo é excluído.Fund
Stepstep.createdOcorre quando um passo da esteira é criado.Step
Stepstep.startedOcorre quando um passo da esteira é iniciado.Step
Stepstep.marked_in_progressOcorre quando um passo da esteira é marcado como em progresso.Step
Stepstep.marked_doneOcorre quando um passo da esteira é marcado como concluído.Step
Stepstep.marked_failedOcorre quando um passo da esteira é marcado como falhado.Step
Stepstep.fulfilledOcorre quando um passo da esteira é cumprido.Step
Settingssettings.updatedOcorre quando alguma configuração é atualizada.Step
Sessionsession.createdOcorre quando um login é feito.Session
Sessionsession.errorOcorre quando um login falha.Session
Sessionsession.endedOcorre quando um logout feito.Session
Sessionsession.refreshOcorre quando um token é atualizado.Session
Sessionsession.otp.email.sentOcorre quando um email é enviado pela seção.SessionEmailNotificationEvent
Sessionsession.otp.sms.sentOcorre quando um sms é enviado pela seção.SessionNotificationEvent
Sessionsession.otp.whatsapp.sentOcorre quando uma menssagem via Whatsapp é enviada pela seção.SessionNotificationEvent
Themetheme.updatedOcorre quando um tema é atualizado.Theme
Subscriptionsubscription.createdOcorre quando uma assinatura é criada.Subscription
Subscriptionsubscription.updatedOcorre quando uma assinatura é atualizada.Subscription
Subscriptionsubscription.deletedOcorre quando uma assinatura é deletada.Subscription
Notificationnotification.sms.sentOcorre quando um sms é enviado (exceto relaciados a seção).NotificationEvent
Notificationnotification.email.sentOcorre quando um email é enviado (exceto relaciados a seção).NotificationEvent