Webhook

A webhook is a special type of synthetic test used to call out to other computer systems to obtain information instead of asking the user.

Webhook settings
Setting
Description
url
​
​
​
URL of the webhook handler
Must be HTTPS
Example:
  "url" : "https://secret-basin-59856.herokuapp.com/webhook"
username

​
​Basic authentication username
Optional (but required if password defined)
Example:
  "username" : "wonka"
password

​
​Basic authentication password
Optional (but required if username defined)
Example:
  "password" : "123456" (use a much stronger password!)
headers






​
List of HTTP headers to pass to webhook handler
You can use these to send the webhook handler additional application-specific data
Do NOT use header keys that might clash with established HTTP header names
Example:
  "headers": [
    {"key" : "key1", "value" : "value1"},
    {"key" : "key2", "value" : "value2"}
  ]
post
https://api.acme.com/v1/webhook
Webhook handler

Rules

How do I?

Last modified 3yr ago

Setting	Description
`url`	URL of the webhook handler Must be HTTPS Example: "url" : "https://secret-basin-59856.herokuapp.com/webhook"
`username`	Basic authentication username Optional (but required if `password` defined) Example: "username" : "wonka"
`password`	Basic authentication password Optional (but required if `username` defined) Example: "password" : "123456" (use a much stronger password!)
`headers`	List of HTTP headers to pass to webhook handler You can use these to send the webhook handler additional application-specific data Do NOT use header keys that might clash with established HTTP header names Example: "headers": [ {"key" : "key1", "value" : "value1"}, {"key" : "key2", "value" : "value2"} ]