List Configuration
GET {{url_contbank}}/partner-bff/s2s/webhooks/configuration?page=1&per_page=12
Listar Configurações de Webhooks
Esta funcionalidade permite listar as configurações de webhooks disponíveis, oferecendo opções de filtragem para encontrar configurações específicas com base em determinados critérios.
Parâmetros da Query (Opcionais):
page (Página desejada)per_page (Número de resultados por página)
Request Schema - Filtros Disponíveis
| Campo | Descrição |
|---|
| context | Segmento para filtrar as configurações. Use BILLINGS para eventos relacionados a boletos. |
| event_name | Tipo de evento para filtrar as configurações. |
| url | URL de destino para filtrar as configurações. |
| contingency_url | URL de contingência para filtrar as configurações em caso de falha na URL principal. |
| active | Indica se a configuração está ativa (true) ou não (false). |
Response Schema - Listagem de Configurações
| Campo | Descrição |
|---|
| total | Total de configurações disponíveis. |
| total_returned | Total de configurações retornadas nesta página. |
| per_page | Número máximo de configurações por página. |
| current_page | Página atual. |
| pages | Total de páginas disponíveis. |
| hasnextpage | Indica se há mais páginas de configurações disponíveis (true) ou não (false). |
| configurations | Lista de configurações de webhooks retornadas. |
| configurations.id | ID único da configuração do webhook. |
| configurations.partner_id | ID do parceiro associado à configuração. |
| configurations.context | Indica o segmento que o webhook está configurado. Use BILLINGS para eventos relacionados a boletos. |
| configurations.event_name | Tipo de evento para o qual o webhook está configurado. |
| configurations.method | Método HTTP esperado para a notificação (ex: POST ). |
| configurations.url | URL de destino para receber as notificações. |
| configurations.contingency_url | URL de contingência para notificações em caso de falha na URL principal. |
| configurations.active | Indica se a configuração está ativa (true) ou não (false). |
| configurations.created_at | Data e hora de criação da configuração. |
| configurations.created_by | ID do usuário que criou a configuração. |
| configurations.updated_at | Data e hora da última atualização da configuração. |
| configurations.updated_by | ID do usuário responsável pela última atualização, se aplicável. |
| configurations.header_authorization | Cabeçalhos de autorização necessários para acesso à URL. |
| configurations.header_authorization.key | Chave de autorização necessária para acesso à URL. |
| configurations.header_authorization.value | Valor da chave de autorização para acesso à URL. |
Request Params
| Key | Datatype | Required | Description |
|---|
page | number | | |
per_page | number | | |
Request Body
{"context"=>"BILLINGS"}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |