Skip to content

Mint webhook ingress endpoints

POST
/api/v1/channels/credentials/{realmName}/ingress
curl --request POST \
--url http://localhost:11044/api/v1/channels/credentials/example/ingress \
--header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

JSON fields: installationId, expectedRevision. The url of each webhook channel, with a new secret returned exactly once. Later calls give the url and a null secret: only the hash is kept.

realmName
required
string

Name of the captured realm installed in the signed-in owner’s world; non-blank, at most 256 UTF-8 bytes, no control characters and not all * (400 otherwise). 409 when its live installation is not the one named by the body’s installationId and expectedRevision. Every webhook channel this realm declares gets an endpoint

OK

Media type*/*
Array<object>

Where one declared webhook channel takes deliveries; answered by POST /channels/credentials/{realmName}/ingress

object
channel
required

Name of the webhook channel the realm declares

string
installation
required

The installation this was read from

object
digest
required

Digest of the realm snapshot the installation admitted, 64 lowercase hex characters

string
installationId
required

The live installation’s id; send it back as installationId on a change

string
realmName
required

Name of the installed realm

string
revision
required

The installation’s revision; send it back as expectedRevision on a change. Every bind or revoke moves it

integer format: int64
secret

The delivery secret, returned only by the call that minted the endpoint; null on every later call, since only its hash is kept

string
url
required

The address to paste into the provider. Absolute when the host is configured with its public origin (assistant.channels.ingress-base-url), otherwise site-relative

string