1. API
  2. Cases
  3. Webhooks

Webhooks: Update

Last updated Open markdown version

Description

Update a case webhook. Supply only the fields you want to change.

Request

HTTP Method: PUT

Path Parameter Description
id The ID of the webhook to update.
Parameter Description
url Optional A new destination URL.
name Optional A new display name. Send an empty string to clear it.
notifications Optional An array of event types that trigger the webhook. Use ["ALL"] for all events. See the create endpoint for the full list of values. 
curl -X PUT \
  https://<tenant-domain>/api/v1/case_webhooks/<<id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
  "url": "https://example.com/updated",
  "name": "Renamed notifier",
  "notifications": ["COMMENTED", "STATUS_UPDATED"]
}'

Response

A successful request will return a JSON object representing the updated webhook.

Field description

Parameter Description
webhook The updated webhook object.

Webhook object fields

Parameter Description
id The webhook ID.
name The webhook name, or null if it has none.
url The destination URL the webhook posts to.
version_number The payload version (1.0 or 2.0).
notifications An array of event types that trigger the webhook (or ["ALL"] for all).
team The team the webhook belongs to.

Team object fields

Parameter Description
id The team ID.
name The team name.

Sample response

{
  "webhook": {
    "id": 1,
    "name": "Renamed notifier",
    "url": "https://example.com/updated",
    "version_number": 2.0,
    "notifications": ["COMMENTED", "STATUS_UPDATED"],
    "team": {
      "id": 10,
      "name": "Security"
    }
  }
}
Was this helpful?