Webhook status

GET

/api/v1/webhooks

const url = 'http://localhost:11044/api/v1/webhooks';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

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

curl --request GET \
  --url http://localhost:11044/api/v1/webhooks \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Shows the local and public webhook URLs (detecting a Tailscale funnel when present), configured sources, and queued sources.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Webhook status

*/*

Where this appliance receives webhooks, and what it is configured to receive

object

configured

required

The webhook sources this world declares handlers for

Array<object>

A webhook source this world can handle

object

action

required

The action that handles it, prefix included

string

description

The action’s own description, where it declares one

string

source

required

The source name a provider posts to, with the webhook- prefix removed

string

localUrl

required

The address reachable on this machine

string

publicUrl

The internet-reachable address, when a Tailscale funnel was detected. Null means providers outside this machine cannot reach it

string

queued

required

Sources holding events that arrived before a handler existed, with how many are waiting

Array<object>

A source with events waiting for a handler

object

eventCount

required

How many are waiting

integer format: int32

source

required

The source the events arrived for

string

tailscale

required

What the Tailscale probe found. Open by contract — it mirrors whatever tailscale status reported

object

key

additional properties

any

webhookUrl

required

The template a provider should be pointed at, with {source} left to substitute. Uses the public URL when one was detected, otherwise the local one

string