get
https://api.caas.staging.bancocdc.com.br/webhook
This endpoint allows you to retrieve information about an existing Webhook.
Attention points:
- To consume the route it is necessary to pass the webhook code in the body where it is available during its creation.
- If you want to list all webhooks linked to the project, you don't need to pass anything in the body of the request.
Response
| Http Code | Return Code | Message |
|---|---|---|
| 200 | 200-01 | Success. |
| 400 | 400-01 | Something unexpected happened. |
| 400 | 400-02 | Invalid hash. |
| 401 | 401-05 | Unauthorized or token invalid |
| 429 | 429-01 | Too many requests |
Response Parameters
| Parameter | Format | Description |
|---|---|---|
| return | Boolean | Indicates if the request was successful. |
| return_code | String | Return code of the request. |
| message | String | Return message of the request. |
| data[i].active | String | Indicates if the webhook is active (Y/N). |
| data[i].description | String | Description of the webhook. |
| data[i].enabled_events | String | Number of enabled events for the webhook. |
| data[i].headers | Object | HTTP headers for the webhook. |
| data[i].code | String | Unique code associated with the webhook. |
| data[i].created_at | String | Date and time when the webhook was created. |
| data[i].updated_at | String | Date and time when the webhook was last updated. |
| data[i].url | String | URL to which the webhook sends payloads. |