/form/:id/webhook

post https://www.formstack.com/api/v2/form/{id}/webhook.json

Add a new webhook to the specified form

POST /api/v2/form/12345/webhook.json HTTP/1.1
Host: www.formstack.com
Authorization: Bearer [[app:oauth_token]]
Accept: application/json
Content-Type: application/json

url=http%3A%2F%2Fwww.example.com

curl -X POST -i -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer [[app:oauth_token]]" -d "url=http%3A%2F%2Fwww.example.com" https://www.formstack.com/api/v2/form/12345/webhook.json

Field Logic

See Field Logic for more information about the logic property.

Path Params

int32

required

Form ID

Body Params

url

string

required

The webhook URL

name

string

Defaults to Submit Action

The webhook name

handshake_key

string

Used to help you prevent unauthorized calls to the webhook url

content_type

string

Defaults to urlencoded

Content Type of webhook data (urlencoded or json)

use_field_ids

boolean

Defaults to false

Flag to use field IDs as array keys in webhook data

no_subfield_names

boolean

Defaults to false

Flag to not include subfield names in webhook data

include_field_type

boolean

Defaults to false

Flag to include field type in webhook data

standardize_field_values

boolean

Defaults to false

Flag to make the structure of the webhook data be consistent. So always an array or string for a field value and not a combination depending on the submitted data.

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://www.formstack.com/api/v2/form/id/webhook.json \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "name": "Submit Action",
8
  "content_type": "urlencoded",
9
  "use_field_ids": false,
10
  "no_subfield_names": false,
11
  "include_field_type": false,
12
  "standardize_field_values": false
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Field Logic

201201

400400

403403

404404

500500