Service Request

Parameters

integration

relationship - required

The integration that the service request is realted to.

parent_servicerequest

relationship - required

If specified, the service request will be attached to another service request.

sequence

integer - required

Order in which the service requests associated with the integration will execute.

system

string - required

Adapter to call. Adapter names are specified within adapter documentation.

service_name

string - required

Service name to be used with associated request. Usage is determined by the adapter being called.

formula_variable

string - required

Variable assigned to the service request. Each service request is created within the namespace using this formula variable. If the call_for_each field is specified then this value is a list.

call_if

boolean - optional

Code block to return a boolean value.

call_for_each (code)

iterable - optional

Specifies an iterable. Service will run for each item within the iterable. Resolves before the call_if block.

message_substitution_name

string - optional

Replaces the sritem with specified string.

notes

Documentation field

Service Request Hooks

These are code blocks that are run during processes of the service request. See the Integration Life Cycle Diagram for timing of the hooks.

  • before_prepare_request_hook

  • after_prepare_request_success_hook

  • after_prepare_request_failure_hook

  • before_execute_request_hook

  • after_execute_request_success_hook

  • after_execute_request_failure_hook

  • abort_after_execute_request_failure

  • skip_execute_if_no_sub_requests

  • after_overall_success_hook

  • after_overall_failure_hook

Attributes

Last updated