Process Step Details - Send Request

The Send Request Automation Step enables practices to send data from FYI to an external system.

The Send Request step is only available when the Automation Process uses one of the following Automation Process Filters:

• Client - Select Filters
• Client - View Filters
• Documents
• Jobs

Send Request

Label

The Label refers to the Automation Step within FYI, for example, when viewing the Automation History. This field is optional, but it's recommended to include the name of the third-party application in the Label for easy identification.

When the process is run, the Automation History will display the Step as "Send Request" followed by the label, e.g. Send request - Send new client to Zapier.

URL

The webhook address where the data from the request will be sent. The URL will be provided by third-party applications, for example, Zapier. This field is mandatory.

Secret

Entering a secret allows recipients to verify the integrity and authenticity of the incoming request from FYI. This field is optional.

When a secret is entered, the Send Request step uses the provided secret string to create a hash of the body of the request using the HMAC SHA256 algorithm. The hash is represented in hexadecimal format and included in the request header "x-fyi-signature". The body is formatted as JSON with no whitespace, consistent with the JSON.stringify JavaScript function.

Object

The type of data to be sent in the request. This field is mandatory.

The options displayed in the drop-down depend on your chosen Automation Filter or steps earlier in the process, and are limited to the following:

• Documents
• Clients
• Jobs

For example, if a Document Filter has been selected, "Trigger Document" will be displayed. If a document, client, or job has been created earlier in the process, the step will be available to select from the drop-down. This also includes the Look Up Job step.