post
https://api.everee.com/integration/v1/partner/webhook-endpoints
Add a URL for Everee to send webhook events to.
Use this endpoint to add a URL that Everee sends your partner webhook events to. A partner can have up to three endpoints.
The response contains the endpoint's signingKey in full, once. Store it now: every later response shows it masked, and you need the full key to verify events. If you lose it, rotate the key to get a new one.
URL rules
- It must be an
httpsURL. - The host must be a public internet host. Addresses on private or internal networks,
localhost, URLs with embedded credentials and URLs with a fragment are rejected. - Two of your active endpoints can't share a URL.
Set enabled to false to create the endpoint switched off. It defaults to true.
Errors
| Status | Meaning |
|---|---|
400 | The URL points at a non-public host, or has credentials or a fragment. |
401 | The API key is missing, malformed or expired. |
403 | The key isn't a partner API key. |
409 | You already have three endpoints, or another endpoint already uses this URL. |
422 | name or url is missing or too long, or url isn't an https URL. |
Part of the Partner Webhook Endpoints API. Authenticate with your partner API key, as for every endpoint in this section. A company API key is refused. See Authentication.