SurveyTale API Docs

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Request Body

application/json

The webhook to create

TypeScript Definitions

Use the request body type in TypeScript.

name*|

The name of the webhook

url*string

The URL of the webhook

Formaturi

source*string

The source of the webhook

Value in"user" | "zapier" | "make" | "n8n"

workspaceId*string

The ID of the workspace

Match^[0-9a-z]+$

Formatcuid2

triggers*array<>

The triggers of the webhook

Items1 <= items

surveyIds*array<>

The IDs of the surveys

Response Body

`application/json`

curl -X POST "https://example.com/management/webhooks" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "url": "http://example.com",    "source": "user",    "workspaceId": "string",    "triggers": [      "responseFinished"    ],    "surveyIds": [      "string"    ]  }'

{
  "id": "string",
  "name": "string",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "url": "http://example.com",
  "source": "user",
  "workspaceId": "string",
  "triggers": [
    "responseFinished"
  ],
  "surveyIds": [
    "string"
  ],
  "secret": "string"
}

Create a webhook

Authorization

Request Body

Response Body

201application/json

`application/json`