> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-formalizacao-de-credito/api-reference/webhooks/webhooks-de-progresso-da-operacao.md).

# Webhooks de progresso da Operação

### Progresso da Operação

Os eventos de progresso da operação visam manter o contratante informado do avanço da CCB.\
Atualmente, são compatíveis os seguintes eventos:

* Sucesso no recebimento da operação

#### Sucesso no recebimento da operação

Envio de informações da confirmação de recebimento da operação enviadas e processadas na Giro.Tech.\
São informados os dados das CCBs recebidas. Para mais informações, avalie o payload do webhook abaixo.

Para cadastrar o envio desses eventos, efetue o [cadastro](https://docs.giro.tech/introducao/produtos-da-giro.tech/formalizacao-de-credito/webhooks/cadastro-de-webhook.md) selecionando o tipo de evento `RECEBIMENTO_OPERACAO`.

## Webhook de notificação de recebimento da CCB

> Envia informações sobre a CCB formalizada com a Giro.\
> \
> ⚠️ Esse endpoint \`webhook/operations/progress/received\` é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.<br>

```json
{"openapi":"3.0.0","info":{"title":"API de Webhooks de Formalização de Crédito","version":"3.0.0"},"servers":[{"url":"https://webhook-endpoint-cliente.exemplo.com","description":"Endpoint configurado pelo cliente para receber webhooks"}],"security":[{"TokenAuth":[]}],"components":{"securitySchemes":{"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization"}}},"paths":{"/webhook/operations/progress/received":{"post":{"summary":"Webhook de notificação de recebimento da CCB","description":"Envia informações sobre a CCB formalizada com a Giro.\n\n⚠️ Esse endpoint `webhook/operations/progress/received` é um exemplo, e pode ser customizado conforme necessidade, pelo cadastro do webhook.\n","tags":["Webhooks de Operações"],"parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"description":"Token de autenticação."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"versao":{"type":"string","maxLength":10,"description":"versão do payload do evento"},"evento":{"type":"string","enum":["CCB_RECEBIDA"],"description":"Tipo do evento"},"id_evento":{"type":"string","description":"Identificador único do evento"},"data_evento":{"type":"string","format":"date-time","description":"Data e horário do evento, conforme o horário universal (UTC)."},"dados":{"type":"object","description":"Dados da CCB formalizada.","properties":{"origem":{"type":"string","maxLength":255,"description":"Identificador único do originador (origem) da formalização da CCB."},"numero_ccb":{"type":"string","maxLength":20,"description":"Número da CCB."},"identificador_programa":{"type":"string","maxLength":255,"description":"Identificador do programa utilizado para formalizar a operação."},"data_recebimento":{"type":"string","format":"date","description":"Data em que a CCB foi recebida pela Giro."}}}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso, webhook entregue"},"400":{"description":"Requisição não processada, webhook não será entregue novamente"},"500":{"description":"Requisição não processada, webhook será entregue novamente após um período"}}}}}}
```
