Skip to main content
POST
/
v2
/
_actions
Create Shopify Action
curl --request POST \
  --url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_actions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "action_timing": "<string>",
  "type": "<string>",
  "webhook": {
    "type": "<string>",
    "mandatory": true,
    "url": "<string>"
  }
}
'
{
  "ctx_id": "<string>",
  "data": {
    "action_id": "<string>",
    "name": "<string>",
    "type": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contactswing.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Authorizations

​
Authorization
string
required
Enter your ContactSwing JWT Bearer token.

​
Request Body

​
name
string
required
Action display name. Example: My Shopify Action
​
description
string
Action purpose. Example: Test
​
action_timing
string
required
When to trigger: "DURING"
​
type
string
required
Action type: "SHOPIFY"
​
webhook
object
required
Shopify webhook configuration
​
type
string
required
Shopify operation type. Example: "contactswing_shopify_search"
​
mandatory
boolean
Require Shopify response before proceeding
​
url
string
Shopify store URL or endpoint

​
Response

201 Created - Shopify action created successfully
​
ctx_id
string
Request context ID
​
data
object
​
action_id
string
New Shopify action ID
​
name
string
Action name
​
type
string
”SHOPIFY”
400 Bad Request - Invalid Shopify webhook configuration 401 Unauthorized - Invalid token