Webhooks
Tipos de eventos
Webhooks
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.
Eventos que ocorrem em sub-recursos, como em installment.paid, não disparam
eventos de atualização no recurso principal, como o loan.updated.
| API | Tipo do evento | Descrição | Modelo |
|---|---|---|---|
| Employment | employment.created | Ocorre quando um novo vínculo empregatício é criado. | Employment |
| Employment | employment.deceased | Ocorre quando um vínculo empregatício é marcado como falecido. | Employment |
| Employment | employment.terminated | Ocorre quando um vínculo empregatício é encerrado. | Employment |
| Employment | employment.deleted | Ocorre quando um vínculo empregatício é deletado. | Employment |
| Employment | employment.transferred | Ocorre quando um vínculo empregatício é marcado como transferido. | Employment |
| ApiKey | api_key.created | Ocorre quando uma nova chave API é criada. | ApiKey |
| ApiKey | api_key.updated | Ocorre quando uma chave API é atualizada. | ApiKey |
| Operator | operator.created | Ocorre quando um novo operador é criado. | Operator |
| Operator | operator.updated | Ocorre quando um operador é atualizado. | Operator |
| Operator | operator.deleted | Ocorre quando um operador é excluído. | Operator |
| Payment Intent | payment_intent.paid | Ocorre quando uma intenção de pagamento é efetuada. | PaymentIntent |
| Payment Intent | payment_intent.voided | Ocorre quando uma intenção de pagamento é anulada. | PaymentIntent |
| Payment Intent | payment_intent.created | Ocorre quando uma intenção de pagamento é criada. | PaymentIntent |
| Invoice | invoice.paid | Ocorre quando uma fatura é paga. | Invoice |
| Invoice | invoice.finalized | Ocorre quando uma fatura é finalizada. | Invoice |
| Invoice | invoice.voided | Ocorre quando uma fatura é anulada. | Invoice |
| Invoice | invoice.created | Ocorre quando uma fatura é criada. | Invoice |
| Invoice | invoice.deleted | Ocorre quando uma fatura é deletada. | Invoice |
| Invoice | invoice.marked_uncollectible | Ocorre quando uma fatura é marcada como incobrável. | Invoice |
| Invoice | invoice.updated | Ocorre quando uma fatura é atualizada. | Invoice |
| Invoice | invoice.expired | Ocorre quando uma fatura expirada é removida automaticamente do sistema. | Invoice |
| Invoice Item | invoice_item.created | Ocorre quando um item de fatura é criado. | Invoice-Item |
| Invoice Item | invoice_item.deleted | Ocorre quando um item de fatura é deletado. | Invoice-Item |
| Payment Method | payment_method.created | Ocorre quando um novo método de pagamento é criado. | PaymentMethod |
| Payment Method | payment_method.voided | Ocorre quando um método de pagamento é anulado. | PaymentMethod |
| Payment Method | payment_method.linked | Ocorre quando um método de pagamento é vinculado a uma conta. | PaymentMethod |
| Payment Method | payment_method.verified | Ocorre quando um método de pagamento é verificado. | PaymentMethod |
| Installment | installment.paid | Ocorre quando uma parcela é paga. | Installment |
| Installment | installment.unpaid | Ocorre quando uma parcela não é paga. | Installment |
| Installment | installment.created | Ocorre quando uma nova parcela é criada. | Installment |
| Installment | installment.transaction.created | Ocorre quando uma transação de parcela é criada. | Installment |
| Installment | installment.voided | Ocorre quando uma parcela é anulada. | Installment |
| Installment | installment.conflicted | Ocorre quando há um conflito em uma parcela. | Installment |
| Installment | installment.marked_uncollectible | Ocorre quando uma parcela é marcada como incobrável. | Installment |
| Company | company.created | Ocorre quando uma nova empresa é criada. | Company |
| Company | company.updated | Ocorre quando uma empresa é atualizada. | Company |
| Company | company.deleted | Ocorre quando uma empresa é excluída. | Company |
| Credit-Policy | credit_policy.created | Ocorre quando uma política de crédito é criada. | Credit-policy |
| Credit-Policy | credit_policy.updated | Ocorre quando uma política de crédito é atualizada. | Credit-policy |
| Credit-Policy | credit_policy.deleted | Ocorre quando uma política de crédito é deletada. | Credit-policy |
| Data-Entity | data_entity.created | Ocorre quando uma entidade é criada. | Data-entity |
| Data-Entity | data_entity.deleted | Ocorre quando uma entidade é deletada. | Data-entity |
| Document | document.created | Ocorre quando um documento é criado. | Document |
| Document | document.updated | Ocorre quando um documento é atualizado. | Document |
| Document | document.deleted | Ocorre quando um documento é deletado. | Document |
| Loan | loan.created | Ocorre quando um novo empréstimo é criado. | Loan |
| Loan | loan.updated | Ocorre quando um empréstimo é atualizado. | Loan |
| Loan | loan.transaction.created | Ocorre quando uma transação de empréstimo é criada. | Loan |
| Loan | loan.disbursed | Ocorre quando um empréstimo é liberado. | Loan |
| Loan | loan.canceled | Ocorre quando um empréstimo é cancelado. | Loan |
| Loan | loan.deleted | Ocorre quando um empréstimo é excluído. | Loan |
| Loan | loan.marked_disbursing | Ocorre quando um empréstimo é marcado para liberação. | Loan |
| Loan | loan.repaid | Ocorre quando um empréstimo é pago. | Loan |
| Loan | loan.expired | Ocorre quando um empréstimo expira. | Loan |
| Loan | loan.marked_pending | Ocorre quando um empréstimo é marcado como pendente. | Loan |
| Loan | loan.marked_open | Ocorre quando um empréstimo é marcado como aberto. | Loan |
| Loan | loan.voided | Ocorre quando um empréstimo é anulado. | Loan |
| Loan | loan.signed | Ocorre quando um empréstimo é assinado. | Loan |
| Loan | loan.file_detached | Ocorre quando um arquivo é desanexado. | Loan |
| Customer | customer.created | Ocorre quando um novo cliente é criado. | Customer |
| Customer | customer.updated | Ocorre quando um cliente é atualizado. | Customer |
| Customer | customer.deleted | Ocorre quando um cliente é deletado. | Customer |
| Customer | customer.file_attached | Ocorre quando um arquivo do cliente é anexado. | Customer |
| Customer | customer.file_detached | Ocorre quando um arquivo do cliente é removido. | Customer |
| Offer | offer.calculated | Ocorre quando uma oferta é calculada. | Offer |
| Offer | offer.created | Ocorre quando uma nova oferta é criada. | Offer |
| File | file.verified | Ocorre quando um arquivo é verificado. | File |
| Webhook event | webhook.event.kobana | Ocorre quando um evento de webhook é processado pelo Kobana. | WebhookEvent |
| Operator Permission | operator_permission.created | Ocorre quando uma nova permissão de operador é criada. | OperatorPermission |
| Operator Permission | operator_permission.updated | Ocorre quando uma permissão de operador é atualizada. | OperatorPermission |
| Operator Permission | operator_permission.deleted | Ocorre quando uma permissão de operador é excluída. | OperatorPermission |
| Product | product.created | Ocorre quando um novo produto é criado. | Product |
| Product | product.updated | Ocorre quando um produto é atualizado. | Product |
| Product | product.deleted | Ocorre quando um produto é excluído. | Product |
| Company Group | company_group.created | Ocorre quando um novo grupo de empresas é criado. | CompanyGroup |
| Company Group | company_group.updated | Ocorre quando um grupo de empresas é atualizado. | CompanyGroup |
| Company Group | company_group.deleted | Ocorre quando um grupo de empresas é excluído. | CompanyGroup |
| Fund | fund.created | Ocorre quando um novo fundo é criado. | Fund |
| Fund | fund.updated | Ocorre quando um fundo é atualizado. | Fund |
| Fund | fund.deleted | Ocorre quando um fundo é excluído. | Fund |
| Step | step.created | Ocorre quando um passo da esteira é criado. | Step |
| Step | step.started | Ocorre quando um passo da esteira é iniciado. | Step |
| Step | step.marked_in_progress | Ocorre quando um passo da esteira é marcado como em progresso. | Step |
| Step | step.marked_done | Ocorre quando um passo da esteira é marcado como concluído. | Step |
| Step | step.marked_failed | Ocorre quando um passo da esteira é marcado como falhado. | Step |
| Step | step.fulfilled | Ocorre quando um passo da esteira é cumprido. | Step |
| Settings | settings.updated | Ocorre quando alguma configuração é atualizada. | Step |
| Session | session.created | Ocorre quando um login é feito. | Session |
| Session | session.error | Ocorre quando um login falha. | Session |
| Session | session.ended | Ocorre quando um logout feito. | Session |
| Session | session.refresh | Ocorre quando um token é atualizado. | Session |
| Session | session.otp.email.sent | Ocorre quando um email é enviado pela seção. | SessionEmailNotificationEvent |
| Session | session.otp.sms.sent | Ocorre quando um sms é enviado pela seção. | SessionNotificationEvent |
| Session | session.otp.whatsapp.sent | Ocorre quando uma menssagem via Whatsapp é enviada pela seção. | SessionNotificationEvent |
| Theme | theme.updated | Ocorre quando um tema é atualizado. | Theme |
| Subscription | subscription.created | Ocorre quando uma assinatura é criada. | Subscription |
| Subscription | subscription.updated | Ocorre quando uma assinatura é atualizada. | Subscription |
| Subscription | subscription.deleted | Ocorre quando uma assinatura é deletada. | Subscription |
| Notification | notification.sms.sent | Ocorre quando um sms é enviado (exceto relaciados a seção). | NotificationEvent |
| Notification | notification.email.sent | Ocorre quando um email é enviado (exceto relaciados a seção). | NotificationEvent |