Skip to main content
POST
Create API Action

Authorizations

string
required
Enter your ContactSwing JWT Bearer token.

Request Body

string
required
Action display name. Example: My API Action
string
required
Action purpose. Example: Post API Action
string
required
When to trigger: "DURING"
string
required
Action type: "WEBHOOK"
object
required
Webhook configuration object
string
required
Target API endpoint. Example: "https://api.publicapis.org/entries"
string
required
HTTP method. Example: "POST"
boolean
Require confirmation before execution. Example: false
object
string
Request headers. Example: {"Content-Type": "application/json"}
array
Request body definition. Example: [{"type":"static","values":{"data":"info"}}]
string
Webhook type. Example: "static"
object
string
Webhook data. Example: "Information"
string
Optional static body payload
string[]
List of required fields
object
Response handling configuration
string
boolean
Run pre-call logic. Example: false
string
Webhook type. Example: "static"

Response

201 Created - Data extraction action created successfully
string
Request context ID
object
string
New extraction action ID
string
Action name
string
”WEBHOOK”
400 Bad Request - Invalid webhook configuration 401 Unauthorized - Invalid token