Search documentation

Search for a topic, a control, or an event type.

    Docs / Workflows / Actions / Webhook

    Webhook

    Send an outgoing HTTP request to an external endpoint. Use the response status and body as results for later jobs.

    Request configuration

    url
    The destination URL can contain event property references. Headers supply the values needed by the receiving service.
    method
    GET, POST or PUT. POST is the default. POST and PUT send the rendered JSON body, while GET sends no body.
    attachEventFiles
    POST and PUT can send selected event files as multipart data. The JSON body uses the payload part and file parts use the configured field name, which defaults to files.

    Response and failure

    A 2xx response succeeds. Other status codes fail the action, and redirects are not followed. Each HTTP request has a 30-second timeout.

    action.status is the HTTP status. action.body contains a JSON object response, or a raw field for other response forms. Map the response values into the output event for later jobs.

    Notify another service

    A POST request can send an order ID and status to a receiving service. The body takes those values from the event, and a successful response can provide the receiving system’s record ID.

    A webhook request of any method needs the Write permission. With Write off, OAIZ sends no request. action.status is 0, and action.body has skipped and reason fields. With Write on, workflow tests send real requests, so use a destination intended for test traffic when the receiving service makes changes.