Change a webhook endpoint

PATCH

/v1/admin/webhooks/{id}

const url = 'https://api.sealcord.com/v1/admin/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"example","event_types":["licence.issued"],"enabled":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.sealcord.com/v1/admin/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "event_types": [ "licence.issued" ], "enabled": true }'

Change the URL or event types, or disable or enable an endpoint.

Authorizations

bearer

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

application/json

object

url

string

>= 1 characters <= 2048 characters

event_types

Array<string>

>= 1 items <= 8 items

Allowed values: licence.issued licence.revoked licence.expired licence.reinstated licence.anonymised licence.trial_converted activation.created activation.deactivated

enabled

boolean

Responses

401

Missing or invalid API key.

403

Needs scope webhooks:write.