API keys and webhooks

Create and revoke API keys, add a webhook with its own signing secret, and send a test delivery — all from Developer.

Embed
Preview of the card
<a href="https://numestri.com/guides/api-keys-and-webhooks"><img src="https://numestri.com/guides/_api/public/orgs/25229885-9620-4c08-bd2e-a0d0d74ac8b6/spaces/eff30848-7ff1-4a21-8a5f-1f282c362fb6/pages/b9f17786-055d-41c0-a053-a993129c79a6/social-card.svg?v=3e7ae33eec8b" alt="API keys and webhooks" width="600" height="315"></a>

Everything for connecting your own software lives under Developer.

API keys

  • New key creates one. Name it after where it will be used, so you know what to revoke later.

  • Revoke stops a key immediately. To change a key: create the new one, start using it, then revoke the old one.

  • No key is made for you — you only have the keys you created.

Webhook

Add a URL and Numestri POSTs every code to it as it arrives, for one-time numbers and for every message a rental receives.

  • Adding the webhook shows its signing secret. Your server uses it to check each delivery really came from Numestri.

  • Send test delivers a signed sample so you can check your receiver.

  • Rotate secret issues a new secret at once — update your server straight after.

  • Remove turns the webhook off.

The full details — payloads, headers, verification code and retries — are in the API docs.

Updated