Create a webhook

POST 
/v3/webhooks

Create a webhook

Request

application/json

Body

name string

Possible values: <= 255 characters

description string

Possible values: <= 1000 characters

url stringrequired

Possible values: <= 1000 characters

event_type string

Possible values: <= 255 characters

Default value: submission_completed

object_type string

Possible values: <= 255 characters

Default value: survey

survey_id numberrequired
http_method stringrequired

Possible values: <= 255 characters, [POST, GET, PATCH, PUT, DELETE]

headers object[]

Possible values: <= 10

type string

Possible values: <= 255 characters

Default value: application

payload object
include_partial_submission boolean

Responses

200

Successful

*/*

Schema

Schema

data

object

id number

name string

Possible values: <= 255 characters

url string

Possible values: <= 1000 characters

eventType string

Possible values: <= 255 characters

description string

Possible values: <= 1000 characters

objectType string

Possible values: <= 255 characters

httpMethod string

Possible values: <= 255 characters

headers

object[]

Array [

key string

Possible values: <= 255 characters

value string

Possible values: <= 255 characters

]

properties

object

payload string

includePartialSubmission boolean

disabled boolean

Example (from schema)

{
  "data": {
    "id": 1,
    "name": "Sample webhook",
    "url": "https://webhook.com/data",
    "eventType": "submission_completed",
    "description": "This is sample webhook",
    "objectType": "survey",
    "httpMethod": "POST",
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "properties": {
      "payload": "{\n\n\"key1\": \"value1\",\n\"key1\":\"value1\"\n\n}",
      "includePartialSubmission": true
    },
    "disabled": false
  }
}

Loading...