put
https://api.everee.com/integration/v1/partner/companies//webhook
Set or change the URL onboarding events are delivered to.
Use this endpoint to set where Everee delivers the company's onboarding events. If the company already has a webhook, its URL is changed. Otherwise one is created. The response includes the signingKey for verifying deliveries. For what's delivered and how to verify it, see the webhooks guide.
Part of Webhook endpoint. For how this fits into onboarding, see the guide: Submitting for review: webhook handling checklist.
You can also supply a webhookUrl when you create the company.
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.
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. |
404 | No company with this ID belongs to your partner account. |
422 | url is missing, or isn't an https URL. |