Use the ‘Data transfer’ action for this.
What is ‘Data transfer’?
The ‘Data transfer’ action allows data to be sent to a specific URL when certain events (set on the workflow) occur. Unlike the traditional API, which requires periodic queries to check if a change has occurred, webhooks automatically send information as soon as a certain event occurs.
Using the ‘Data transfer’ action, you can send to the external application (POST method) the data of your choice from the process (e.g. the employee's name, date of employment or other data that was collected during their process).
The receiving application must be able to display all received HTTP requests that have been sent to this unique URL. For testing the ‘Data transfer’ action, you can use https://webhook.site/, which:
- automatically generates a unique URL. This URL acts as an ‘endpoint’, i.e. an endpoint to which applications can send data.
- will receive and display all received HTTP requests that have been sent to this unique URL using the ‘Data transfer’ action.
The ‘Data transfer’ action can use the ‘Send test’ function, which sends test data and a JSON shape to the specified URL.
When sending files, the ‘Data transfer’ action will return to the recipient the URL to the file for downloading. In order to download the file, it is necessary to have the API KEY and API SECRET keys (you can do so here: https://gamfi.support/help/quickstart), which are used for authentication during download.
GET + URL returned by the ‘Data transfer’ action.
Example cURL:
curl --location '' \
--header 'X-Samus-Authorization-Api-Key: {apiKey}' \
--header 'X-Samus-Authorization-Api-Secret: {apiSecret}' \
--header 'Content-Type: application/json'
- {URL} - URL returned by the ‘Data transfer’ action to the file
- {apiKey} - insert API key
- {apiSecret} - insert API secret