Inkress DevelopersWebhook endpoints · Add an endpoint
API reference / Webhook endpoints
Add an endpoint
POST/api/v1/webhook_urlswebhooks:manage
Adds a URL that gets one event, or a group: orders, subscriptions or all. Webhooks.
Body
urlstringrequired
Your endpoint, up to 512 characters. Use HTTPS.
eventstringrequired
One event like orders.paid, or a group: orders, subscriptions, all, or the families subscription, card_charge, refund. Event types.
merchant_idinteger
For an organisation key: the merchant it's for.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The endpoint.
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
422 | The URL or event is missing, or the URL isn't a web address. |