Update Webhook Endpoint

PATCH /v1/webhook-endpoints/{id}

Update an outbound webhook endpoint

cURL

curl --request PATCH \
  --url https://api.example.com/v1/webhook-endpoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Slack #alerts",
  "url": "https://hooks.slack.com/services/T00/B00/xxx",
  "events": [
    "budget.threshold_reached",
    "policy.violation"
  ],
  "enabled": true
}
'

import requests

url = "https://api.example.com/v1/webhook-endpoints/{id}"

payload = {
    "name": "Slack #alerts",
    "url": "https://hooks.slack.com/services/T00/B00/xxx",
    "events": ["budget.threshold_reached", "policy.violation"],
    "enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Slack #alerts',
    url: 'https://hooks.slack.com/services/T00/B00/xxx',
    events: ['budget.threshold_reached', 'policy.violation'],
    enabled: true
  })
};

fetch('https://api.example.com/v1/webhook-endpoints/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/webhook-endpoints/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Slack #alerts',
    'url' => 'https://hooks.slack.com/services/T00/B00/xxx',
    'events' => [
        'budget.threshold_reached',
        'policy.violation'
    ],
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/webhook-endpoints/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Slack #alerts\",\n  \"url\": \"https://hooks.slack.com/services/T00/B00/xxx\",\n  \"events\": [\n    \"budget.threshold_reached\",\n    \"policy.violation\"\n  ],\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.example.com/v1/webhook-endpoints/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Slack #alerts\",\n  \"url\": \"https://hooks.slack.com/services/T00/B00/xxx\",\n  \"events\": [\n    \"budget.threshold_reached\",\n    \"policy.violation\"\n  ],\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/webhook-endpoints/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Slack #alerts\",\n  \"url\": \"https://hooks.slack.com/services/T00/B00/xxx\",\n  \"events\": [\n    \"budget.threshold_reached\",\n    \"policy.violation\"\n  ],\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Body

application/json

name · string

Human-readable name for this endpoint

Example:

"Slack #alerts"

url · string

Destination URL for webhook delivery

Example:

"https://hooks.slack.com/services/T00/B00/xxx"

type · enum<string>

Payload format: slack uses the Slack incoming-webhook shape

Available options: slack, generic

events · string[]

Event types this endpoint subscribes to

Example:

[
  "budget.threshold_reached",
  "policy.violation"
]

enabled · boolean

Enable or disable delivery to this endpoint

Example:

true

Response

200 - undefined