Create Configuration
POST {{url_contbank}}/partner-bff/s2s/webhooks/configuration
Criar Configuração de Webhook
Esta funcionalidade permite criar uma nova configuração de webhook para um determinado contexto e evento. Ao criar uma configuração, é possível definir URLs de destino para notificações, incluindo uma URL de contingência para situações inesperadas. Além disso, é possível configurar cabeçalhos de autorização para garantir a segurança da comunicação.
Request Schema
| Campo | Descrição |
|---|
| context | Indica o segmento que o webhook será configurado. Use BILLINGS para receber eventos relacionados a boletos. |
| event_name | Define o tipo de evento para o qual o webhook será configurado. Opções disponíveis: CREATED , UPDATED , CANCELED , PAID_OUT . |
| url | URL de destino para receber as notificações. |
| contingency_url | URL de contingência para notificações em caso de falha na URL principal. |
| header_authorization | Cabeçalhos de autorização necessários para acesso à URL (opcional). (ex. [key :X-token , value :valor da chave ] ) |
Response Schema
| Campo | Descrição |
|---|
| id | ID único da configuração do webhook. |
| partner_id | ID do parceiro associado à configuração. |
| context | Indica o segmento que o webhook está configurado. Use BILLINGS para eventos relacionados a boletos. |
| event_name | Tipo de evento para o qual o webhook está configurado. |
| method | Método HTTP esperado para a notificação (ex: POST ). |
| url | URL de destino para receber as notificações. |
| contingency_url | URL de contingência para notificações em caso de falha na URL principal. |
| active | Indica se a configuração está ativa (true) ou não (false). |
| created_at | Data e hora de criação da configuração. |
| created_by | ID do usuário que criou a configuração. |
| updated_at | Data e hora da última atualização da configuração. |
| updated_by | ID do usuário responsável pela última atualização, se aplicável. |
| header_authorization | Cabeçalhos de autorização necessários para acesso à URL (opcional). |
| request_id | ID da requisição associada à configuração do webhook. |
Request Body
{"context"=>"BILLINGS", "event_name"=>"CREATED", "url"=>"https://seudominio.com.br/suarota", "contingency_url"=>"https://seudominio.com.br/contingencia/suarota", "header_authorization"=>[{"key"=>"X-Token-Id", "value"=>"123456"}]}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |