Terms used

This page uses generally accepted and newly coined terms. Definitions of the most commonly used terms in this document are provided below.

Push API – is the tool that allows websites to send instant messages (webhooks) to your Endpoint URL, on something triggers like creating a new account, changing SIM usage, etc. This tool sends a webhook from one application to another application when something event was triggered. For example, you can set up your endpoint URL to send a webhook notification when something Prepaid SIM Card has 200 MB of usage remaining.

All webhooks described in this docs use the standard JSON syntax.

Webhook – is the HTTP POST request to your endpoint URL, called in Push API process.

Endpoint URL – is a URL link to your-side web server that implements a handler of webhook with different payloads. For example, a handler of the "echo" webhook payload is necessarily required to work with Push API (for more details, see section 2).

Webhook Payload – is a body of Webhook. This docs define the set of default payloads that may occur in webhooks (for more information about webhook payloads, see section 5).

Webhook Payload Model – is a typical JSON that can occur in different webhook payloads. Models have required and optional fields, and are designed to unify sets of parameters of default objects like SIM Card, Account, etc. (for more information about webhook payload models, see section 4).