Skip to main content
POST
/
webhooks
Create Webhook
curl --request POST \
  --url https://access.utgl.io/v1/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhook",
  "events": [
    "<string>"
  ],
  "name": "My Webhook"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "My Webhook",
  "url": "https://your-webhook.server/utgl-access-webhooks",
  "events": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
url
string
required

URL to receive notifications. Must be a valid https:// url with a valid SSL certificate signed by a trusted CA.

Example:

"https://example.com/webhook"

​
events
string[]
required

The list of events to enable for this webhook endpoint. You may specify [’*’] to enable all events.

​
name
string

Name of the webhook, for your reference. If name is not provided, default name (webhook id) will be used.

Example:

"My Webhook"

Response

200 - application/json

Webhook created

​
id
string<uuid>

Webhook ID

​
name
string

Name of webhook

Example:

"My Webhook"

​
url
string

URL of webhook endpoint

Example:

"https://your-webhook.server/utgl-access-webhooks"

​
status
enum<string>
  • created webhook has been recently created, pending initial health check
  • healthy webhook is active and there are no delivery issues
  • unhealthy webhook is in degraded state and deliveries are being retried
  • error webhook is in error state and deliveries are suspended
  • removed webhook has been removed
Available options:
created,
healthy,
unhealthy,
error,
removed
​
events
string[]

List of subscribed events