Skip to main content

Telerivet Adaptor

About Telerivet​

Telerivet is a platform for sending, receiving, and automating SMS, voice calls, and mobile messaging through various channels. Telerivet is commonly used for customer notifications, marketing campaigns, and transactional messaging.

Integration Options​

Telerivet supports 2 primary integration options with OpenFn:

  1. Rest API: Telerivet has a REST API that enables external services like OpenFn to pull data from Telerivet, or push data from external apps to Telerivet. This option is suited for scheduled, bulk syncs or workflows that must update data in Telerivet with external information. See functions for more on how to use this adaptor to work with the API.

  2. Webhook: Webhook or Data Forwarding to push data from Telerivet to external systems (see docs). This option is suited for real-time, event-based data integration.

Authentication​

  1. See Telerivet docs for the latest on supported authentication methods.
  2. When integrating with Telerivet via OpenFn, there is one primary authentication method that is supported: API Key. See this adaptor's Configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "projectId": "telerivet_project_id",
  "apiKey": "telerivet_api_key"
}
  1. Telerivet API Documentation
  2. Webhook Setup

Implementation Examples​

Coming soon!