Skip to main content
PATCH
/
api
/
v1
/
webhook-subscriptions
/
{id}
Update Webhook Subscription
curl --request PATCH \
  --url https://api.passentry.com/api/v1/webhook-subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookSubscription": {
    "url": "https://example.com/webhook/updated",
    "enabled": false,
    "subscribedEvents": [
      "passInstalled",
      "passRemoved",
      "passCreated"
    ]
  }
}
'
import requests

url = "https://api.passentry.com/api/v1/webhook-subscriptions/{id}"

payload = { "webhookSubscription": {
        "url": "https://example.com/webhook/updated",
        "enabled": False,
        "subscribedEvents": ["passInstalled", "passRemoved", "passCreated"]
    } }
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({
    webhookSubscription: {
      url: 'https://example.com/webhook/updated',
      enabled: false,
      subscribedEvents: ['passInstalled', 'passRemoved', 'passCreated']
    }
  })
};

fetch('https://api.passentry.com/api/v1/webhook-subscriptions/{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.passentry.com/api/v1/webhook-subscriptions/{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([
    'webhookSubscription' => [
        'url' => 'https://example.com/webhook/updated',
        'enabled' => false,
        'subscribedEvents' => [
                'passInstalled',
                'passRemoved',
                'passCreated'
        ]
    ]
  ]),
  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.passentry.com/api/v1/webhook-subscriptions/{id}"

	payload := strings.NewReader("{\n  \"webhookSubscription\": {\n    \"url\": \"https://example.com/webhook/updated\",\n    \"enabled\": false,\n    \"subscribedEvents\": [\n      \"passInstalled\",\n      \"passRemoved\",\n      \"passCreated\"\n    ]\n  }\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.passentry.com/api/v1/webhook-subscriptions/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhookSubscription\": {\n    \"url\": \"https://example.com/webhook/updated\",\n    \"enabled\": false,\n    \"subscribedEvents\": [\n      \"passInstalled\",\n      \"passRemoved\",\n      \"passCreated\"\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.passentry.com/api/v1/webhook-subscriptions/{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  \"webhookSubscription\": {\n    \"url\": \"https://example.com/webhook/updated\",\n    \"enabled\": false,\n    \"subscribedEvents\": [\n      \"passInstalled\",\n      \"passRemoved\",\n      \"passCreated\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "01983282-53cf-7e16-b5e1-dd0de4ce02fa",
    "type": "webhookSubscription",
    "attributes": {
      "url": "https://example.com/webhook/updated",
      "secretKey": "a2e2c04657b924390d2a2623439c65734d07e0f8",
      "enabled": false,
      "scopeType": "organisation",
      "scopeName": "Test Organisation",
      "subscribedEvents": [
        "passInstalled",
        "passRemoved",
        "passCreated"
      ]
    }
  }
}
{
  "errors": [
    "Invalid URL format"
  ]
}
{
  "errors": [
    "<string>"
  ]
}
{
  "errors": [
    "Webhook subscription not found"
  ]
}
{
  "errors": [
    "URL must be HTTPS"
  ]
}
Note: The scope (organisation/entity) of a webhook subscription cannot be changed after creation. To change the scope, create a new webhook subscription and delete the old one.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Webhook subscription ID

Body

application/json

Webhook subscription update configuration

webhookSubscription
object
required

Response

Webhook subscription updated successfully

data
object