Setting webhook authentication
Add an authentication mechanism to a webhook in a particular tenant.
Procedure
-
In a REST client platform, add the authentication details of the tenant to apply an
authentication to a webhook.
//In case of Instance API key Headers: { "x-instance-api-key": "instance_api_key" } // In case of MCSP or ISV token Headers: { "Authorization": "mcsp_or_isv_token" } Body: { "auth*":"none" OR "login" OR "token" } // The default value for the auth field is "login". - Make a POST request at the URL of the project. URL Syntax:
<domain>/apis/v1/rest/projects/:project/webhook-flows/:workflow_uid/authIn this URL request, /:project is the name of the project that is associated with the workflow where you want to apply an authentication to a webhook. The /:workflow_uid is the ID of the workflow where you want to apply an authentication to a webhook.
Method: POST
If the request is successful, you receive the response code for success.{ output: { "uid": "<workflow_uid>", "name": "<workflow_name>", "tenant_uid": "<tenant_uid>", "project_uid": "<project_uid>", "sid": <workflow_sid>, "webhook_settings": <webhook_settings> } }