Set up a webhook endpoint

Webhooks let your systems react when something happens in your yggy organization. yggy sends a signed POST request with a JSON body to an HTTPS URL you register, for each event you subscribe to.

Set up an endpoint

1. Open Developers → Webhooks. Only organization owners and admins see this tab.
2. Choose Add endpoint, enter an HTTPS URL, an optional description, and the events you want.
3. Copy the signing secret. It is shown once, starts with whsec_, and the dialog stays open until you choose Done. Store the secret in your secret manager.
4. Open the endpoint and choose Send test event to check that your server answers.

An organization can have up to 10 endpoints. The URL must use HTTPS and must not contain a user name or password. Any port works. URLs that resolve to private, loopback or link-local addresses are refused. On a self-hosted installation, your operator can allow private addresses for internal receivers. That setting covers every private and loopback address at once, for every organization admin on the installation, so turn it on only when all of them may reach that network.

Next

• Verify signatures before you trust a payload.
• See every event and its payload in the Event catalog.
• Learn how Retries and redelivery work.