Create a webhook.

Create a webhook. The webhook method and target_path fields are required. Method can either be DELETE,GET,PUT,POST or PATCH.

POST /api/hooks

Try it

Create a webhook.

cURL

curl --request POST \
  --url https://{tenant}/api/hooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "header_map": {},
  "method": "<string>",
  "name": "<string>",
  "target_path": "<string>"
}
'

200

{
  "ID": "<string>",
  "Message": "<string>",
  "Meta": "<unknown>",
  "Status": "<string>"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Body

application/json

Webhook data.

header_map · object

Show child attributes

header_map. {key} · string

method · string

name · string

target_path · string

Response

200

application/json

Webhook created.

ID · string

Message · string

Meta · any

Status · string