callint

callint(path_name: str, payload: Any, extended_payload: Bool = False, force_run_mode: str = None) -> Any

Used to call an integration from within the process of the currently running integration. callint will return the integration output.

Parameters
Description

path_name

The integration name

payload

String or dict object to be used as the integration's Input payload.

extended_payload=False

See Extended Payload section below.

force_run_mode=None

Allows overriding the called integrations run_async field. None: No override (default) sync: Force run_async to be False async: Force run_async to be True.

payload = "input_str"
x = callint("test_integration", payload)

Integrations triggered by callint() will appear in the Run History.

Extended Payload

When extended_payload is False (default), the called integration runs as if it was triggered from a POST request to /integrations/execute/[integration_path_name] with payload representing the body of the post request.

When extended_payload is True, the object passed to payload can have the following additional keys (all optional):

  • params

  • path

  • headers

  • method

  • fullpath

This is useful for emulating the behavior of calling an integration from a Web Services endpoint. For example,

payload = {
    "payload": {
        "firstName": "Sally",
        "lastName": "Smith",
    },
    "method": "POST"
}

x = callint("user", payload, extended_payload=True)

Last updated