Webhook

Webhook is a method utilized by applications to supply real-time information to other apps. Such a process usually delivers data immediately as and when it occurs. Webhook Trigger enables users to receive callouts whenever a service provides the option of distributing signals to a user-defined URL.

Categories: helpers

Type: webhook/v1

---

Actions

Response to Webhook Request

Name: responseToWebhookRequest

Converts the response to the webhook request.

Properties

Name	Label	Type	Control Type	Description	Required
responseType	Response Type	STRING Options JSON, RAW, BINARY, REDIRECT, NO_DATA	SELECT	The type of the response.	null
headers	Headers	OBJECT Properties {}	OBJECT_BUILDER	The headers of the response.	null
body	Body	OBJECT Properties {}	OBJECT_BUILDER	The body of the response.	true
body	Body	STRING	TEXT	The body of the response.	true
body	Redirect URL	STRING	TEXT	The redirect URL.	true
body	Body	FILE_ENTRY	FILE_ENTRY	The body of the response.	true
statusCode	Status Code	INTEGER	INTEGER	The status code of the response.	null

JSON Example

{
  "label" : "Response to Webhook Request",
  "name" : "responseToWebhookRequest",
  "parameters" : {
    "responseType" : "",
    "headers" : { },
    "body" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "statusCode" : 1
  },
  "type" : "webhook/v1/responseToWebhookRequest"
}

Triggers

Auto Respond with HTTP 200 Status

Name: autoRespondWithHTTP200

The webhook trigger always replies immediately with an HTTP 200 status code in response to any incoming webhook request. This guarantees execution of the webhook trigger, but does not involve any validation of the received request.

Type: STATIC_WEBHOOK

Output

Sample Output:

{method=POST, headers={}, parameters={}}

null

JSON Example

{
  "label" : "Auto Respond with HTTP 200 Status",
  "name" : "autoRespondWithHTTP200",
  "type" : "webhook/v1/autoRespondWithHTTP200"
}

Validate and Respond

Name: validateAndRespond

Upon receiving a webhook request, it goes through a validation process. Once validated, the webhook trigger responds to the sender with an appropriate HTTP status code.

Type: STATIC_WEBHOOK

Properties

Name	Label	Type	Control Type	Description	Required
csrfToken	CSRF Token	STRING	TEXT	To trigger the workflow successfully, the security token must match the X-Csrf-Token HTTP header value passed by the client.	true

Output

Sample Output:

{method=POST, headers={}, parameters={}}

null

JSON Example

{
  "label" : "Validate and Respond",
  "name" : "validateAndRespond",
  "parameters" : {
    "csrfToken" : ""
  },
  "type" : "webhook/v1/validateAndRespond"
}

Await Workflow and Respond

Name: awaitWorkflowAndRespond

You have the flexibility to set up your preferred response. After a webhook request is received, the webhook trigger enters a waiting state for the workflow’s response.

Type: STATIC_WEBHOOK

Properties

Name	Label	Type	Control Type	Description	Required
csrfToken	CSRF Token	STRING	TEXT	To trigger the workflow successfully, the security token must match the X-Csrf-Token HTTP header value passed by the client.	true
timeout	Timeout (ms)	INTEGER	INTEGER	The incoming request will time out after the specified number of milliseconds. The max wait time before a timeout is 5 minutes.	null

Output

Sample Output:

{method=POST, headers={}, parameters={}}

null

JSON Example

{
  "label" : "Await Workflow and Respond",
  "name" : "awaitWorkflowAndRespond",
  "parameters" : {
    "csrfToken" : "",
    "timeout" : 1
  },
  "type" : "webhook/v1/awaitWorkflowAndRespond"
}

---