Update Webhook

Update a web hook using its ID. The webhook method and target_path fields are required in the request body when updating. Note the original webhook data will be completely replaced with the new update request object(so if for example you don’t send the name or webhook_id fields in your request body those fields will be updated to empty string even if they existed in your original webhook object.)

PUT /api/hooks/{hookId}

Try it

Update Webhook

cURL

curl --request PUT \
  --url https://{tenant}/api/hooks/{hookId} \
  --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

Path Parameters

hookId · string · required

ID of the webhook to update

Body

application/json

header_map · object

Show child attributes

header_map. {key} · string

method · string

name · string

target_path · string

Response

200

application/json

Webhook updated.

ID · string

Message · string

Meta · any

Status · string