Module iris.subscriptions

ballerinax/iris.subscriptions Ballerina library

1.2.0

Overview

This is a generated connector for IRIS Subscriptions API v1.6.4 OpenAPI specification. Connect with the Subscriptions API to create, view, and manage your event notification subscriptions.
A webhook listener URL is required from you to be able to create the subscription and receive notifications. Learn about API updates and new endpoints by subscribing to the api.updated event. Receive alerts in real-time including lead status changes, e-signature document actions, and helpdesk ticket changes. Subscription API responses provide you with detailed information on a silver platter to avoid sorting through data unnecessarily.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the IRIS Subscriptions connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/iris.subscriptions module into the Ballerina project.

Copy
import ballerinax/iris.subscriptions;

Step 2: Create a new connector instance

Create a subscriptions:ApiKeysConfig with the API key obtained, and initialize the connector with it.

Copy
subscriptions:ApiKeysConfig config = {
    xApiKey: "<API_KEY>"
}
subscriptions:Client baseClient = check new Client(config);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to get a list of subscriptions using the connector.

    Return a list of subscriptions

    Copy
    public function main() returns error? {
        subscriptions:InlineResponse20056 response = check baseClient->getSubscriptions();
        log:printInfo(response.toString());
    }
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/iris.subscriptions;Copy

Metadata

Released date: about 2 years ago

Version: 1.2.0

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.0.0

GraalVM compatible: Yes


Pull count

Total: 0

Current verison: 0


Weekly downloads


Source repository


Keywords

Sales & CRM/Customer Relationship Management

Cost/Paid


Contributors

Other versions

See more...