Workflow Web Request Actions

List of valid attributes:

Attribute	Description	Specifics
body	Body content of the request	Optional. Supports liquid templates
created_at	Timestamp of creation	Cannot be set
header	HTTP headers to include in the request	Optional object where all values are strings.
method	HTTP method used for the request	Required. Allowed methods: “get”, “post”, “put”, “patch”, “delete”
url	Target URL for the request	Required.
previous_action_id	ID of the previous workflow action in the sequence	Optional

Create

Example request:

{
  "data": {
    "type": "workflow_web_request_action",
    "attributes": {
      "method": "get",
      "url": "https://example.com",
      "previous_action_id": "9ee58efe-7ce5-4143-99d3-954303b188f3"
    }
  }
}

Example response:

{
  "data": {
    "id": "85579c3b-22ea-43b8-ab79-d60d05680be5",
    "type": "workflow_web_request_action",
    "attributes": {
      ...
    }
  }
}

This endpoint creates a new web request action for a workflow.

HTTP Request

POST /api/v1/workflows/:workflow_id/web_request_actions

URL Parameters

Parameter	Description
workflow_id	The ID of the workflow that the action belongs to

Update

Example request:

{
  "data": {
    "type": "workflow_web_request_action",
    "attributes": {
      "method": "post"
    }
  }
}

Example response:

{
  "data": {
    "id": "85579c3b-22ea-43b8-ab79-d60d05680be5",
    "type": "workflow_web_request_action",
    "attributes": {
      ...
    }
  }
}

This endpoint updates a web request action.

HTTP Request

PUT /api/v1/workflows/:workflow_id/web_request_actions/:web_request_action_id

URL Parameters

Parameter	Description
web_request_action_id	The ID of the web request action to update
workflow_id	The ID of the workflow that the action belongs to