Outgoing webhook
Um OutgoingWebhook representa a configuração de um endpoint externo para o qual os eventos de automação são enviados. "Outgoing" refere-se a eventos que saem da plataforma Portant em direção a um destino externo.
Para detalhes sobre os eventos que o Portant envia, consulte Listen to events from Portant via webhooks.
Fields
| Field | Type | Description |
|---|---|---|
| id | String | O ID da configuração do outgoing webhook. |
| webhookUrl | String | O endereço do webhook para o qual os eventos serão enviados via POST. |
Example
{
"id": "owc_XY1Ys4gqrpX8cp",
"webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},
Endpoints
Obter um outgoing webhook
GET /workflows/<wkf_id>/outgoing-webhooks/
Recupere a configuração do outgoing webhook para um workflow específico.
Responses
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 403 Unauthorised | Error |
Criar um outgoing webhook
POST /workflows/<wkf_id>/outgoing-webhooks/
Crie a configuração do outgoing webhook para um workflow específico.
Request
O corpo deve conter um único campo webhookUrl com a URL na qual você deseja receber os eventos.
{
webhookUrl: "https://..."
}
Responses
| Status | Body |
|---|---|
| 201 Created | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |
Atualizar um outgoing webhook
PATCH /workflows/<wkf_id>/outgoing-webhooks/
Atualize a configuração do outgoing webhook para um workflow específico.
Request
O corpo deve conter um único campo webhookUrl com a URL na qual você deseja receber os eventos.
{
webhookUrl: "https://..."
}
Responses
| Status | Body |
|---|---|
| 200 OK | OutgoingWebhook |
| 400 Bad Request | Error |
| 403 Unauthorised | Error |