Webhook saliente

Un OutgoingWebhook representa la configuración de un endpoint externo al que se envían los eventos de automatización. "Outgoing" (saliente) hace referencia a los eventos que salen de la plataforma Portant hacia un destino externo.

Para obtener detalles sobre los eventos que Portant envía, consulte Escuchar eventos de Portant mediante webhooks.

Campos

Campo	Tipo	Descripción
id	String	El ID de la configuración del webhook saliente.
webhookUrl	String	La dirección del webhook a la que se enviarán los eventos mediante POST.

Ejemplo

{
    "id": "owc_XY1Ys4gqrpX8cp",
    "webhookUrl": "https://webhook.site/d22c56ab-40ac-4f9a-93ef-02520235c0da"
},

Endpoints

Obtener un webhook saliente

GET /workflows/<wkf_id>/outgoing-webhooks/

Recupere la configuración del webhook saliente para un flujo de trabajo específico.

Respuestas

Estado	Cuerpo
200 OK	OutgoingWebhook
403 Unauthorised	Error

Crear un webhook saliente

POST /workflows/<wkf_id>/outgoing-webhooks/

Cree la configuración del webhook saliente para un flujo de trabajo específico.

Solicitud

El cuerpo debe contener un único campo webhookUrl con la URL en la que desea recibir los eventos.

{
    webhookUrl: "https://..."
}

Respuestas

Estado	Cuerpo
201 Created	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error

Actualizar un webhook saliente

PATCH /workflows/<wkf_id>/outgoing-webhooks/

Actualice la configuración del webhook saliente para un flujo de trabajo específico.

Solicitud

El cuerpo debe contener un único campo webhookUrl con la URL en la que desea recibir los eventos.

{
    webhookUrl: "https://..."
}

Respuestas

Estado	Cuerpo
200 OK	OutgoingWebhook
400 Bad Request	Error
403 Unauthorised	Error