Skip to main content
POST
/
webhooks
Create webhook
curl --request POST \
  --url https://api.sftpsync.io/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "eventType": "<string>",
  "headers": {},
  "secret": "<string>",
  "isActive": true
}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "url": "<string>",
  "eventType": "<string>",
  "headers": {},
  "secret": "<string>",
  "isActive": true,
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json
name
string
required
url
string<uri>
required
eventType
string
required
description
string
headers
object
secret
string
isActive
boolean

Response

200 - application/json

Webhook

id
string
required
name
string
required
url
string<uri>
required
eventType
string
required
isActive
boolean
required
workspaceId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
headers
object
secret
string