Webhooks

Webhooks icon

Webhooks enable Claris Connect® to post or accept data on a specific URL. A webhook can also accept data to trigger a flow. Data can be a JSON object.

Triggers

Trigger Configuration fields Data type Required?
Incoming HTTP Request - A new HTTP request will be received by the webhook

Choose webhook - Enable Return sync response for the webhook on the Webhooks page to set synchronization.

To customize the response, add the webhook action and choose Reply with JSON in the flow.

Choice Checkmark icon, required field

Actions

Action Configuration fields Data type Required?
HTTP GET request - Sends a GET request

URL - Send request to this URL

Text

Checkmark icon, required field

Send as JSON? - If Yes, the results go to a JSON key. If No, a form is simulated.

Choice

 
JSON Key - If sending JSON, enter a key String  
Query string - Enter a parameter and a value. The string will be URL-encoded and appended to the URL. Key value  
Header - Enter a key-value pair to be added as a headers in all requests Key value  
Authentication - Enter a username | password (pipe-separated) for standard HTTP authentication String  
HTTP POST request - Sends a POST request

URL - Send request to this URL

Text

Checkmark icon, required field

Content-type - Choose the content type of the request payload Choice Checkmark icon, required field
Data - Enter the JSON data JSON Checkmark icon, required field
File - Enter a name and a link for a file object to be attached to the request. The request will be converted to multipart/form-data. Key value  
Header - Enter a key-value pair to be added as a headers in all requests Key value  
Authentication - Enter a username | password (pipe-separated) for standard HTTP authentication String  
HTTP PATCH request - Sends a PATCH request

URL - Send request to this URL

Text

Checkmark icon, required field

Content-type - Choose the content type of the request payload Choice Checkmark icon, required field
Data - Enter the JSON data JSON Checkmark icon, required field
File - Enter a name and a link for a file object to be attached to the request. The request will be converted to multipart/form-data. Key value  
Header - Enter a key-value pair to be added as a headers in all requests Key value  
Authentication - Enter a username | password (pipe-separated) for standard HTTP authentication String  
HTTP PUT request - Sends a PUT request

URL - Send request to this URL

Text

Checkmark icon, required field

Content-type - Choose the content type of the request payload Choice Checkmark icon, required field
Data - Enter the JSON data JSON Checkmark icon, required field
File - Enter a name and a link for a file object to be attached to the request. The request will be converted to multipart/form-data. Key value  
Header - Enter a key-value pair to be added as a headers in all requests Key value  
Authentication - Enter a username | password (pipe-separated) for standard HTTP authentication String  
Reply with JSON Data - Returns custom JSON as a response

Response data - Enter the JSON data for the response

JSON

Checkmark icon, required field

Status code - Choose the status code to send in response Choice