Appearance
API key and webhooks
Your developers use the host API to sync your customers with BMA and to see what each customer has bought. Webhooks tell your servers as soon as something changes. Only owners can manage these.
- 1Create (or replace) the API key. It is shown once.
- 2Add a webhook endpoint: its HTTPS address and the events you want.
Create the API key
- Open Host portal → API & webhooks and click Create key (or Replace key).
- Copy the key straight away: it's shown once, starting with
mph_. Give it to your developers through a secure channel, never by plain email or chat. - Replace key stops the old key at once, so your developers must switch to the new one straight away.
Add a webhook endpoint
- Under Webhooks, type the URL (https) of your server and a Description.
- Tick the Events you want;
entitlement.granted,entitlement.suspendedandentitlement.revokedare ticked for you. - Click Add endpoint and copy the signing secret it shows (once).
- Use Send test to check your server receives it.
Each endpoint has New secret, Pause / Resume and Delete. After 25 failed deliveries in a row an endpoint is switched off and you're emailed; fix your server and click Resume.
Related
- Host API and webhooks (for developers)
- Webhook events