📘

O que você irá aprender com esse artigo?

• Gatilhos
• Ativar Gatilhos
• Lista de Gatilhos disponíveis
• E-mails Transacionais

Gatilhos

Os Gatilhos (ou Webhooks) são notificações enviadas pela iugu. São usadas para alterar o status dos fluxos (como faturas, saques e etc) no seu sistema interno.

Ativar Gatilhos

Configurar Gatilhos pelo painel da iugu

Para habilitar os Gatilhos via dashboard, efetue o login em sua conta iugu, localize o menu e siga o caminho: Configurações >> Comunicação via Gatilhos, conforme apresentado a seguir.

Ao acessar essa interface, é possível cadastrar os eventos de Webhook que deseja receber no sistema terceiro. Para isso, basta clicar no botão “Novo”, atribuir a URL do sistema que irá receber os Gatilhos, selecionar o evento que deseja habilitar e clicar no botão “Salvar”, conforme apresentado a seguir.

Como ativar os Gatilhos usando a API

Para habilitar os Gatilhos via API, utilize a chamada de Criar Gatilho informando o evento que deseja receber juntamente do endereço (URL) da sua aplicação/sistema. O seu servidor deve retornar com uma resposta HTTP 200 (status Ok). Caso contrário, a iugu enviará novamente o gatilho.

Lista de Gatilhos disponíveis

A iugu disponibiliza em sua API uma série de eventos de Webhooks que estão em determinados fluxos, como: mudança de estado de uma fatura, liquidação da fatura, status de transferência bancária, notificação de falha no pagamento e etc. Veja alguns casos de uso envolvendo o uso de Gatilhos.

• invoice.status_changed: Evento usado para notificar a mudança de status de uma fatura. Para mais informações, clique aqui.

• invoice.released: Evento usado para notificar quando todas as parcelas de uma fatura foram liquidadas, ou seja, o valor está disponível para saque. Para mais informações, clique aqui.

• withdraw_request.status_changed: usado para notificar a mudança de status de um saque. Para mais informações, clique aqui.

• invoice.payment_failed: Evento usado para notificar quando ocorrer alguma falha/erro na tentativa de pagamento de uma fatura usando cartão de crédito. Para mais informações, clique aqui.

Para informações sobre como realizar o reenvio dos Gatilhos, clique aqui.

Veja maiores detalhes sobre o uso de todos os Gatilhos clicando aqui.

E-mails Transacionais

Os E-mails Transacionais são mensagens de correio eletrônico usadas para notificar o cliente a respeito de alguns cenários (como lembre de fatura, por exemplo). A gestão dos e-mails transacionais pode ser feita via API. Veja alguns casos de uso a seguir.

• invoice_reminder: E-mail enviado para o cliente como lembrete, informando quando a fatura está perto de vencer. Usado principalmente na recorrência;

• invoice_due: E-mail enviado para o cliente avisando que a fatura venceu;

• subscription_charge_failure: E-mail enviado para o cliente informando que ocorreu uma falha na cobrança automática da assinatura.

Veja mais detalhes sobre o uso de todos os E-mails Transacionais clicando aqui.

Para informações sobre como alterar o layout dos E-mails, clique aqui.