Skip to content

Lynn's REST API

Lynn not only limits itself to the integration of external channels and services, but it also provides mechanisms for exploiting its modules through the provision of REST APIs that give access to advanced integration functions such as Exploitation of graphs and history, management of proactive modules and management with the messaging manager, the latter enables the possibility of third-party bot integrations that adopt the transaction message scheme suggested by Lynn.

Types of APIs Available

Messaging (Interacts with the messaging broker).

Proactive (Manages campaigns, adds contacts and starts campaigns).

Reports (Retrieves data from active reports).

Limitations of Messaging API

  • Load testing is not allowed on productive instances.

  • Transactions on the API must correspond to the purpose of the invoked method.

  • Resources invoked in the API must have legitimate purpose.

  • Denial calls are not allowed.

  • The test environment includes session handling restrictions.

  • Exploitation credentials must be treated confidentially.

Messaging and Proactive Documentation

https://documenter.getpostman.com/view/4212906/UVCCd3Aq

Webhook

Webhook is a listening URL that allows Lynn to notify the availability of read messages, each app has the possibility to configure its webhooks that must comply with basic parameters:

  • Ability to receive HTTPS verb POST calls.

  • Reachable from Lynn's cloud instance.

  • Ability to process the "readMessage" reading structure in JSON format.

  • (Desired) Ability to register transactions.

  • Response times @800 Ses <= 1.4sec peak normal