Ferramentas - Webhooks

A Trio utiliza webhooks para enviar atualizações de maneira assíncrona sobre os endpoints de uma Connection.

O webhook pode ser configurado através dos endpoints disponíveis na nossa API.

Em cada notificação a Trio executa um POST com um payload no format JSON na URL cadastrada. Se a resposta da requisição não retornar o código 2XX, faremos mais 3 tentativas com alguns minutos de diferença entre elas.

Eventos

Todas as notificações disparados na Trio seguem um padrão de acordo com o exemplo abaixo:

{
  "event": {
    "id": "",
    "category": "",
    "type": "",
    "company_id": "",
    "webhook_id": "",
    "status": "completed" //completed or failed
  },
  "data": {}, //when completed with success
  "error": {} //when failed
}

Balances

Com os webhooks vinculados a Balance é possível receber notificações sempre que houver uma atualização de saldo na instituição financeira.

Atualização do saldo

Você receberá o hook fetch_balances toda a vez que um processo de atualização na instituição financeira for concluído e receberá um payload como este:

{
  "event": {
    "id": "aadf41a1fc8e4f79a49f7f04027ac999",
    "category": "BALANCES",
    "type": "fetch_balances",
    "company_id": "881319d0-c7c4-4dbf-8a5e-6dcc167b8cdd",
    "webhook_id": "018a7714-5628-4b4b-a34e-68ea729cf6de",
    "status": "completed"
  },
  "data": {
    "account_id": "acd4feed-fd57-499a-a4db-5d6a1cd057e6",
    "amount": { "amount": 28048963, "currency": "BRL" },
    "id": "b5e2c558-873a-4d01-a7ee-afa939c95372",
    "inserted_at": "2021-11-29T12:37:13",
    "timestamp": "2021-11-29T12:37:13Z",
    "updated_at": "2021-11-29T12:37:13"
  }
}

Se durante a atualização acontecer algum erro por falha de autenticação ou indisponibilidade você receberá uma resposta como esta:

{
  "event": {
    "id": "aadf41a1fc8e4f79a49f7f04027ac999",
    "category": "BALANCES",
    "type": "fetch_balances",
    "company_id": "881319d0-c7c4-4dbf-8a5e-6dcc167b8cdd",
    "webhook_id": "018a7714-5628-4b4b-a34e-68ea729cf6de",
    "status": "failed"
  },
  "error": {
    "code": "unexpected_error",
    "message": "Unexpected error occurred"
  }
}

Transactions

Com os webhooks vinculados a Transaction é possível receber notificações sempre que houver uma atualização das transações na instituição financeira ou integração recorrente.

Atualização das transações

Você receberá o hook transactions_updated toda a vez que um processo de atualização na instituição financeira for concluído e receberá um payload como este:

{
  "event": {
    "id": "aadf41a1fc8e4f79a49f7f04027ac999",
    "category": "TRANSACTIONS",
    "type": "fetch_transactions",
    "company_id": "881319d0-c7c4-4dbf-8a5e-6dcc167b8cdd",
    "webhook_id": "018a7714-5628-4b4b-a34e-68ea729cf6de",
    "status": "completed"
  },
  "data": {
    "total_transactions": 6
  }
}

Se durante a atualização acontecer algum erro por falha de autenticação ou indisponibilidade você receberá uma resposta como esta:

{
  "event": {
    "id": "aadf41a1fc8e4f79a49f7f04027ac999",
    "category": "TRANSACTIONS",
    "type": "fetch_transactions",
    "company_id": "881319d0-c7c4-4dbf-8a5e-6dcc167b8cdd",
    "webhook_id": "018a7714-5628-4b4b-a34e-68ea729cf6de",
    "status": "completed"
  },
  "error": {
    "code": "unexpected_error",
    "message": "Unexpected error occurred"
  }
}