Function: events.await_callback

Waits for a callback to be received at the given endpoint.

For more information, see Wait using callbacks.

Arguments

Arguments
callback A map object with a url field that stores the URL of the created endpoint.
timeout

float

The maximum request timeout in seconds (default: 43200.0).

Returns

The callback request received.

Raised exceptions

Exceptions
TimeoutError In case of a timeout.
ValueError In case of invalid input values.
TypeError In case of invalid input types.

Examples

# A basic callback workflow
- create_callback:
    call: events.create_callback_endpoint
    args:
        http_callback_method: "GET"
    result: callback_details
- print_callback_details:
    call: sys.log
    args:
        severity: "INFO"
        text: ${"Listening for callbacks on " + callback_details.url}
- await_callback:
    call: events.await_callback
    args:
        callback: ${callback_details}
        timeout: 3600
    result: callback_request
- print_callback_request:
    call: sys.log
    args:
        severity: "INFO"
        text: ${"Received " + json.encode_to_string(callback_request.http_request)}
- return_callback_result:
    return: ${callback_request.http_request}