Patch Webhook

Patch org team webhook via the Junction API. Requires authentication with your team API key.

PATCH /v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id}

Patch Webhook

cURL

curl --request PATCH \
  --url https://api.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Management-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "rate_limit": 123,
  "url": "<string>",
  "disabled": true,
  "filter_types": "daily.data.activity.created"
}
'

import requests

url = "https://api.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id}"

payload = {
    "description": "<string>",
    "rate_limit": 123,
    "url": "<string>",
    "disabled": True,
    "filter_types": "daily.data.activity.created"
}
headers = {
    "X-Management-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Management-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    rate_limit: 123,
    url: '<string>',
    disabled: true,
    filter_types: 'daily.data.activity.created'
  })
};

fetch('https://api.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_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.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_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([
    'description' => '<string>',
    'rate_limit' => 123,
    'url' => '<string>',
    'disabled' => true,
    'filter_types' => 'daily.data.activity.created'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Management-Key: <api-key>"
  ],
]);

$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.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"rate_limit\": 123,\n  \"url\": \"<string>\",\n  \"disabled\": true,\n  \"filter_types\": \"daily.data.activity.created\"\n}")

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

	req.Header.Add("X-Management-Key", "<api-key>")
	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.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id}")
  .header("X-Management-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"rate_limit\": 123,\n  \"url\": \"<string>\",\n  \"disabled\": true,\n  \"filter_types\": \"daily.data.activity.created\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.management.junction.com/v1/org/{org_id}/team/{team_id}/{environment}/webhook/{webhook_id}")

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

request = Net::HTTP::Patch.new(url)
request["X-Management-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"rate_limit\": 123,\n  \"url\": \"<string>\",\n  \"disabled\": true,\n  \"filter_types\": \"daily.data.activity.created\"\n}"

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

200

{
  "id": "<string>",
  "url": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "rate_limit": 123,
  "disabled": false,
  "filter_types": "daily.data.activity.created"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Junction Management API is available for the Scale plan.

The base URL of this endpoint is https://api.management.junction.com/.

The endpoint accepts only Management Key (X-Management-Key). Team API Key is not accepted.

Authorizations

X-Management-Key · string · header · required

Path Parameters

org_id · string<uuid> · required

team_id · string<uuid> · required

environment · enum<string> · required

Available options: production, sandbox

webhook_id · string · required

Body

application/json

description · string | null

rate_limit · integer | null

url · string | null

disabled · boolean | null

filter_types · string[] | null

For the complete list of events, check out the Event Catalog.

Example:

"daily.data.activity.created"

Response

200

application/json

Successful Response

id · string · required

url · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

description · string | null

rate_limit · integer | null

disabled · boolean | null · default: false

filter_types · string[] | null

For the complete list of events, check out the Event Catalog.

Example:

"daily.data.activity.created"