iris.subscriptions
Module iris.subscriptions
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_iris.subscriptions_1.3.0.png)
ballerinax/iris.subscriptions Ballerina library
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:
- Create a IRIS CRM account
- Obtain tokens by following this guide
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.
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.
subscriptions:ApiKeysConfig config = { xApiKey: "<API_KEY>" } subscriptions:Client baseClient = check new Client(config);
Step 3: Invoke connector operation
-
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
public function main() returns error? { subscriptions:InlineResponse20056 response = check baseClient->getSubscriptions(); log:printInfo(response.toString()); }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
iris.subscriptions: Client![](/images/permalink.svg)
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.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a IRIS account and obtain tokens by following this guide.
init (ApiKeysConfig apiKeyConfig, string serviceUrl, ClientConfiguration clientConfig)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- serviceUrl string - URL of the target service
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
getSubscriptions![](/images/permalink.svg)
function getSubscriptions(int? page, int? perPage) returns InlineResponse20056|error
Return a list of subscriptions
Return Type
- InlineResponse20056|error - A JSON array of subscriptions
createSubscription![](/images/permalink.svg)
function createSubscription(BriefSubscriptionInfo payload) returns BriefSubscriptionInfo|error
Create a subscription
Parameters
- payload BriefSubscriptionInfo - Subscription details
Return Type
- BriefSubscriptionInfo|error - Subscription has been created successfully
getSubscriptionsById![](/images/permalink.svg)
function getSubscriptionsById(int subscriptionId) returns BriefSubscriptionInfo|error
Return a subscription by its id
Parameters
- subscriptionId int - Subscription Id
Return Type
- BriefSubscriptionInfo|error - Subscription
deleteSubscription![](/images/permalink.svg)
function deleteSubscription(int subscriptionId) returns InlineResponse20057|error
Delete a subscription
Parameters
- subscriptionId int - Subscription Id
Return Type
- InlineResponse20057|error - Subscription (1) has been deleted successfully
updateSubscription![](/images/permalink.svg)
function updateSubscription(int subscriptionId, BriefSubscriptionInfo payload) returns BriefSubscriptionInfo|error
Update a subscription
Return Type
- BriefSubscriptionInfo|error - Subscription has been updated successfully
testPayloadForCheckingServerResponse![](/images/permalink.svg)
function testPayloadForCheckingServerResponse() returns TestSubscription|error
Test payload for checking server response
Return Type
- TestSubscription|error - Response
receiveNotificationWhenApiUpdated![](/images/permalink.svg)
function receiveNotificationWhenApiUpdated() returns ApiUpdated|error
Receive a notification when this API is updated
Return Type
- ApiUpdated|error - API details
receiveNotificationWhenLeadCreated![](/images/permalink.svg)
function receiveNotificationWhenLeadCreated() returns LeadCreatedEventInfo|error
Receive a notification when a lead is created in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here
Return Type
- LeadCreatedEventInfo|error - Lead details
receiveNotificationWhenLeadUpdated![](/images/permalink.svg)
function receiveNotificationWhenLeadUpdated() returns LeadUpdatedEventInfo|error
Receive a notification when a lead's campaign, status, group, or field values are updated in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here
Return Type
- LeadUpdatedEventInfo|error - Lead details
receiveNotificationWhenLeadDeleted![](/images/permalink.svg)
function receiveNotificationWhenLeadDeleted() returns LeadDeletedEventInfo|error
Receive a notification when a lead in this CRM is deleted
Return Type
- LeadDeletedEventInfo|error - Lead details
receiveNotificationWhenLeadRestored![](/images/permalink.svg)
function receiveNotificationWhenLeadRestored() returns LeadRestoredEventInfo|error
Receive a notification when a deleted lead is restored in this CRM
Return Type
- LeadRestoredEventInfo|error - Lead details
receiveNotificationWhenLeadStatusUpdated![](/images/permalink.svg)
function receiveNotificationWhenLeadStatusUpdated() returns LeadStatusUpdatedEventInfo|error
Receive a notification when a lead's status is updated in this CRM, with the option to only receive a notification when a lead is moved to or from the status(es) specified here
Return Type
- LeadStatusUpdatedEventInfo|error - Lead details
receiveNotificationWhenLeadEsignatureGenerated![](/images/permalink.svg)
function receiveNotificationWhenLeadEsignatureGenerated() returns SignatureGenerated|error
Receive a notification when a lead's e-signature document is generated
Return Type
- SignatureGenerated|error - Lead details
receiveNotificationWhenLeadEsignatureOpened![](/images/permalink.svg)
function receiveNotificationWhenLeadEsignatureOpened() returns SignatureOpened|error
Receive a notification when a lead's e-signature document is opened by the recipient
Return Type
- SignatureOpened|error - Lead details
receiveNotificationWhenLeadEsignatureSigned![](/images/permalink.svg)
function receiveNotificationWhenLeadEsignatureSigned() returns SignatureSigned|error
Receive a notification when a lead's e-signature document is signed by the recipient
Return Type
- SignatureSigned|error - Lead details
receiveNotificationWhenLeadNoteAdded![](/images/permalink.svg)
function receiveNotificationWhenLeadNoteAdded() returns LeadNoteAddedEventInfo|error
Receive a notification when a lead in this CRM has a note posted, with the option to only receive a notification when a lead is in the status(es) specified here
Return Type
- LeadNoteAddedEventInfo|error - Lead details
receiveNotificationWhenLeadDocumentUploaded![](/images/permalink.svg)
function receiveNotificationWhenLeadDocumentUploaded() returns LeadDocumentUploadedEventInfo|error
Receive a notification when a lead document is uploaded
Return Type
- LeadDocumentUploadedEventInfo|error - Lead details
receiveNotificationWhenLeadEmailReceived![](/images/permalink.svg)
function receiveNotificationWhenLeadEmailReceived() returns LeadEmailReceivedEventInfo|error
Receive a notification when an email message is received on a lead in this CRM, with the option to only receive a notification when a lead is in the status(es) specified here
Return Type
- LeadEmailReceivedEventInfo|error - Lead details
receiveNotificationWhenTurboAppSubmitted![](/images/permalink.svg)
function receiveNotificationWhenTurboAppSubmitted() returns TurboAppSubmited|error
Receive a notification when a TurboApp is submitted to a processor
Return Type
- TurboAppSubmited|error - Application details
receiveNotificationWhenTurboAppUpdated![](/images/permalink.svg)
function receiveNotificationWhenTurboAppUpdated() returns TurboAppUpdated|error
Receive a notification when the underwriting status is updated
Return Type
- TurboAppUpdated|error - Application account details
receiveNotificationWhenTurboAppApproved![](/images/permalink.svg)
function receiveNotificationWhenTurboAppApproved() returns TurboAppApproved|error
Receive a notification when a merchant is approved
Return Type
- TurboAppApproved|error - Application details
receiveNotificationWhenTurboAppDeclined![](/images/permalink.svg)
function receiveNotificationWhenTurboAppDeclined() returns TurboAppDeclined|error
Receive a notification when a merchant is declined
Return Type
- TurboAppDeclined|error - Application details
receiveNotificationWhenTurboAppCreated![](/images/permalink.svg)
function receiveNotificationWhenTurboAppCreated() returns TicketCreated|error
Receive a notification when a ticket is created
Return Type
- TicketCreated|error - Ticket created
receiveNotificationWhenTicketUpdated![](/images/permalink.svg)
function receiveNotificationWhenTicketUpdated() returns TicketUpdated|error
Receive a notification when a ticket is updated
Return Type
- TicketUpdated|error - Ticket updated
receiveNotificationWhenTicketResolved![](/images/permalink.svg)
function receiveNotificationWhenTicketResolved() returns TicketResolved|error
Receive a notification when a ticket is resolved
Return Type
- TicketResolved|error - Ticket resolved
receiveNotificationWhenTicketCommented![](/images/permalink.svg)
function receiveNotificationWhenTicketCommented() returns TicketCommented|error
Receive a notification when a ticket comment is added
Return Type
- TicketCommented|error - Ticket commented
receiveNotificationWhenTicketCommentEdited![](/images/permalink.svg)
function receiveNotificationWhenTicketCommentEdited() returns SubscriptionCommentEdited|error
Receive a notification when a ticket comment is edited
Return Type
- SubscriptionCommentEdited|error - Ticket comment edited
receiveNotificationWhenReportPublished![](/images/permalink.svg)
function receiveNotificationWhenReportPublished() returns ReportPublished|error
Receive a notification when a residuals report is published
Return Type
- ReportPublished|error - Report details
receiveNotificationWhenLineItemAdded![](/images/permalink.svg)
function receiveNotificationWhenLineItemAdded() returns LineItemAdded|error
Receive a notification when a residuals line item is added
Return Type
- LineItemAdded|error - Line item details
receiveNotificationWhenChargebackAdded![](/images/permalink.svg)
function receiveNotificationWhenChargebackAdded() returns ChargebackAdded|error
Receive a notification when a new chargeback case created
Return Type
- ChargebackAdded|error - Chargeback case details
receiveNotificationWhenChargebackUpdated![](/images/permalink.svg)
function receiveNotificationWhenChargebackUpdated() returns ChargebackUpdated|error
Receive a notification when chargeback case status changed
Return Type
- ChargebackUpdated|error - Chargeback case details
receiveNotificationForChargebackReminder![](/images/permalink.svg)
function receiveNotificationForChargebackReminder() returns ChargebackReminder|error
Receive a notification in 7/3/1 days before the chargeback case due date
Return Type
- ChargebackReminder|error - Chargeback case details
receiveNotificationWhenRetrievalAdded![](/images/permalink.svg)
function receiveNotificationWhenRetrievalAdded() returns RetrievalAdded|error
Receive a notification when a new retrieval case created
Return Type
- RetrievalAdded|error - Retrieval case details
receiveNotificationWhenRetrievalUpdated![](/images/permalink.svg)
function receiveNotificationWhenRetrievalUpdated() returns RetrievalUpdated|error
Receive a notification when retrieval case status changed
Return Type
- RetrievalUpdated|error - Retrieval case details
receiveNotificationForRetrievalReminder![](/images/permalink.svg)
function receiveNotificationForRetrievalReminder() returns RetrievalReminder|error
Receive a notification in 7/3/1 days before the retrieval case due date
Return Type
- RetrievalReminder|error - Retrieval case details
Records![](/images/permalink.svg)
iris.subscriptions: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
X-API-KEY
iris.subscriptions: ApiUpdated![](/images/permalink.svg)
Fields
- hook ApiupdatedHook? -
- data ApiupdatedData? -
iris.subscriptions: ApiupdatedData![](/images/permalink.svg)
Fields
- 'version string? - Version number
- update string? - Should users do an update of their API clients functional
- details ApiupdatedDataDetails[]? -
- createdAt string? - Date and time of creation (ISO 8601)
iris.subscriptions: ApiupdatedDataDetails![](/images/permalink.svg)
Fields
- description string? - Description of update
- link string? - Link to endpoint documentation
- 'type string? - Type of API update
iris.subscriptions: ApiupdatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: ApplicationSubscription![](/images/permalink.svg)
Fields
- id int? -
- title string? -
- group_id int? -
- group_name string? -
iris.subscriptions: BriefSubscriptionInfo![](/images/permalink.svg)
Fields
- id int? - Subscription Id
- url string - Subscription URL
- events string[] - Subscription Events
- options BriefsubscriptioninfoOptions? - Options for each event
- multiple_at_once boolean? - Report multiple items in one request
iris.subscriptions: BriefsubscriptioninfoOptions![](/images/permalink.svg)
Options for each event
Fields
- leadStatusUpdated BriefsubscriptioninfoOptionsLeadstatusupdated? - Statuses from which a lead should be updated
- leadCreated BriefsubscriptioninfoOptionsLeadcreated? - Statuses with which a lead should be created
- leadNoteAdded BriefsubscriptioninfoOptionsLeadnoteadded? - Statuses of leads whose notes should be added
- leadDocumentUploaded BriefsubscriptioninfoOptionsLeaddocumentuploaded? - Statuses of leads whose documents should be uploaded
- leadEmailReceived BriefsubscriptioninfoOptionsLeademailreceived? - Statuses of leads whose emails should received
iris.subscriptions: BriefsubscriptioninfoOptionsLeadcreated![](/images/permalink.svg)
Statuses with which a lead should be created
Fields
- statuses int[]? - Statuses with which a created lead should be reported (any if not specified)
iris.subscriptions: BriefsubscriptioninfoOptionsLeaddocumentuploaded![](/images/permalink.svg)
Statuses of leads whose documents should be uploaded
Fields
- statuses int[]? - Statuses of leads whose uploaded documents should be reported (any if not specified)
iris.subscriptions: BriefsubscriptioninfoOptionsLeademailreceived![](/images/permalink.svg)
Statuses of leads whose emails should received
Fields
- statuses int[]? - Statuses of leads whose received emails should be reported (any if not specified)
iris.subscriptions: BriefsubscriptioninfoOptionsLeadnoteadded![](/images/permalink.svg)
Statuses of leads whose notes should be added
Fields
- statuses int[]? - Statuses of leads whose added notes should be reported (any if not specified)
iris.subscriptions: BriefsubscriptioninfoOptionsLeadstatusupdated![](/images/permalink.svg)
Statuses from which a lead should be updated
Fields
- previousStatuses int[]? - Statuses from which a lead should be updated to report the update (any if not specified)
- newStatuses int[]? - Statuses to which a lead should be updated to report the update (any if not specified)
iris.subscriptions: ChargebackAdded![](/images/permalink.svg)
Fields
- hook ChargebackaddedHook? -
- data ChargebackaddedData? -
iris.subscriptions: ChargebackaddedData![](/images/permalink.svg)
Fields
- chargebacks ChargebackReplyResponse[]? -
iris.subscriptions: ChargebackaddedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: ChargebackReminder![](/images/permalink.svg)
Fields
- hook ChargebackreminderHook? -
- data ChargebackreminderData? -
iris.subscriptions: ChargebackreminderData![](/images/permalink.svg)
Fields
- chargebacks record { due_in int? }[]? -
iris.subscriptions: ChargebackreminderHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: ChargebackReplyResponse![](/images/permalink.svg)
Fields
- chargeback ChargebackreplyresponseChargeback? -
- items ChargebackreplyresponseItems? -
- Fields Included from *DisputeDetailsResponse
- transactions DisputedetailsresponseTransactions[]|()
- auth_records DisputedetailsresponseTransactions[]|()
- notes DisputedetailsresponseNotes[]|()
- messages DisputedetailsresponseMessages[]|()
- directories DisputedetailsresponseDirectories[]|()
- anydata...
iris.subscriptions: ChargebackreplyresponseChargeback![](/images/permalink.svg)
Fields
- id string? -
- merchant_id string? -
- dba string? -
- cycle_indicator string? -
- date string? -
- transaction_date string? -
- amount string? -
- reason_code string? -
- reason string? -
- card_number string? -
- case_number string? -
- case_action string? -
- action string? -
- reply_form string? -
- case_status string? -
- case_status_description string? -
- last_status_date string? -
- respond_due string? -
- original_amount string? -
- updated_at string? -
- mcc string? -
- dispute_jurisdiction string? -
- card_product_type string? -
- process_date string? -
- transaction_method string? -
- invoice_number string? -
- microfilm_number string? -
- airline_ticket_number string? -
- order_number string? -
- tracking_number string? -
iris.subscriptions: ChargebackreplyresponseItems![](/images/permalink.svg)
Fields
- reason string? -
- message_from_bank string? -
- merchant_due_date string? -
- financial_disposition_date string? -
- 'type string? -
iris.subscriptions: ChargebackUpdated![](/images/permalink.svg)
Fields
- hook ChargebackupdatedHook? -
- data ChargebackaddedData? -
iris.subscriptions: ChargebackupdatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: CommentSubscriptionData![](/images/permalink.svg)
Fields
- ticket_url string? -
- assignedUsers UserListStructure? - Assigned users
- files File[]? -
- merchantVisible boolean? - Indicates if the comment is visible for Merchant users
iris.subscriptions: DisputeDetailsResponse![](/images/permalink.svg)
Fields
- transactions DisputedetailsresponseTransactions[]? -
- auth_records DisputedetailsresponseTransactions[]? -
- notes DisputedetailsresponseNotes[]? -
- messages DisputedetailsresponseMessages[]? -
- directories DisputedetailsresponseDirectories[]? -
iris.subscriptions: DisputedetailsresponseDirectories![](/images/permalink.svg)
Fields
- time string? -
- title string? -
- files DisputedetailsresponseFiles[]? -
iris.subscriptions: DisputedetailsresponseFields![](/images/permalink.svg)
Fields
- 'key string? -
- value string? -
iris.subscriptions: DisputedetailsresponseFiles![](/images/permalink.svg)
Fields
- time string? -
- title string? -
- url string? - site url
- api_url string? - api url
iris.subscriptions: DisputedetailsresponseMessages![](/images/permalink.svg)
Fields
- message string? -
- description string? -
- added_at string? -
- viewed_on string? -
iris.subscriptions: DisputedetailsresponseNotes![](/images/permalink.svg)
Fields
- message string? -
- added_at string? -
iris.subscriptions: DisputedetailsresponseTransactions![](/images/permalink.svg)
Fields
- reference string? -
- fields DisputedetailsresponseFields[]? -
iris.subscriptions: File![](/images/permalink.svg)
Fields
- id int? -
- name string? -
- size int? -
- created string? - File creation date (Y-m-d\TH:i:sP)
- created_by int? -
iris.subscriptions: FullLeadSubscription![](/images/permalink.svg)
Fields
- Fields Included from *ShortLeadSubscription
- id int|()
- lead_url string|()
- name string|()
- email string|()
- contact string|()
- phone string|()
- address LeademailreceivedeventinfoDataAddress|()
- assignedUsers UserStructure[]|()
- anydata...
- id int? - Lead ID
- lead_url string? - Lead URL
- name string? - Lead Name
- email string? - Lead Default Email
- contact string? - Lead Default Contact Name
- phone string? - Lead Default Contact Phone Number
- address LeademailreceivedeventinfoDataAddress? -
- 'group FullleadsubscriptionGroup? -
- category FullleadsubscriptionCategory? -
- status FullleadsubscriptionStatus? -
- campaign FullleadsubscriptionCampaign? -
- 'source FullleadsubscriptionSource? -
- createdAt string? - Date and time of creation (ISO 8601)
- createdBy UserStructure? -
iris.subscriptions: FullleadsubscriptionCampaign![](/images/permalink.svg)
Fields
- id int? - Campaign ID
- name string? - Campaign Name
iris.subscriptions: FullleadsubscriptionCategory![](/images/permalink.svg)
Fields
- id int? - Status category ID
- name string? - Status category Name
iris.subscriptions: FullleadsubscriptionGroup![](/images/permalink.svg)
Fields
- id int? - Group ID
- name string? - Group Name
iris.subscriptions: FullleadsubscriptionSource![](/images/permalink.svg)
Fields
- id int? - Source ID
- name string? - Source Name
iris.subscriptions: FullleadsubscriptionStatus![](/images/permalink.svg)
Fields
- id int? - Status ID
- name string? - Status Name
iris.subscriptions: InlineResponse20056![](/images/permalink.svg)
Fields
- data BriefSubscriptionInfo[]? -
- links Links? -
- meta Meta? -
iris.subscriptions: InlineResponse20057![](/images/permalink.svg)
Fields
- message string? - Subscription deletion message
iris.subscriptions: LeadCreatedEventInfo![](/images/permalink.svg)
Fields
- hook LeadcreatedeventinfoHook? -
- data LeadcreatedeventinfoData? -
iris.subscriptions: LeadcreatedeventinfoData![](/images/permalink.svg)
Fields
- lead FullLeadSubscription? -
- leads FullLeadSubscription[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeadcreatedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadDeletedEventInfo![](/images/permalink.svg)
Fields
- hook LeaddeletedeventinfoHook? -
- data LeaddeletedeventinfoData? -
iris.subscriptions: LeaddeletedeventinfoData![](/images/permalink.svg)
Fields
- lead record { deletedBy UserStructure? }? -
- leads record { deletedBy UserStructure? }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeaddeletedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadDocumentUploadedEventInfo![](/images/permalink.svg)
Fields
iris.subscriptions: LeaddocumentuploadedeventinfoData![](/images/permalink.svg)
Fields
iris.subscriptions: LeaddocumentuploadedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadEmailReceivedEventInfo![](/images/permalink.svg)
Fields
- hook LeademailreceivedeventinfoHook? -
- data LeademailreceivedeventinfoData? -
iris.subscriptions: LeademailreceivedeventinfoData![](/images/permalink.svg)
Fields
- lead LeademailreceivedeventinfoDataLead? - 'lead' property is passed when 'Multiple at once' feature is disabled
- leads LeademailreceivedeventinfoDataLeads[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeademailreceivedeventinfoDataAddress![](/images/permalink.svg)
Fields
- address string? - Lead Default Address
- city string? - Lead Default City
- state string? - Lead Default State
- zip string? - Lead Default ZIP
iris.subscriptions: LeademailreceivedeventinfoDataEmail![](/images/permalink.svg)
Fields
- 'from string? - Sent from (name and email)
- to string? - Sent to(email)
- subject string? - Email subject
- bodyText string? - Email message without html
- bodyHtml string? - Email message including html
- sentAt string? - Date and time of receiving the email (ISO 8601)
iris.subscriptions: LeademailreceivedeventinfoDataLead![](/images/permalink.svg)
'lead' property is passed when 'Multiple at once' feature is disabled
Fields
- id int? - Lead ID
- lead_url string? - Lead URL
- name string? - Lead Name
- emailAddress string? - Lead Default Email
- contact string? - Lead Default Contact Name
- phone string? - Lead Default Contact Phone Number
- address LeademailreceivedeventinfoDataLeadAddress? - Address
- email LeademailreceivedeventinfoDataLeadEmail? - Email
- assignedUsers UserListStructure? - Assigned users
iris.subscriptions: LeademailreceivedeventinfoDataLeadAddress![](/images/permalink.svg)
Address
Fields
- address string? - Lead Default Address
- city string? - Lead Default City
- state string? - Lead Default State
- zip string? - Lead Default ZIP
iris.subscriptions: LeademailreceivedeventinfoDataLeadEmail![](/images/permalink.svg)
Fields
- 'from string? - Sent from (name and email)
- to string? - Sent to(email)
- subject string? - Email subject
- bodyText string? - Email message without html
- bodyHtml string? - Email message including html
- sentAt string? - Date and time of receiving the email (ISO 8601)
iris.subscriptions: LeademailreceivedeventinfoDataLeads![](/images/permalink.svg)
Fields
- id int? - Lead ID
- lead_url string? - Lead URL
- name string? - Lead Name
- emailAddress string? - Lead Default Email
- contact string? - Lead Default Contact Name
- phone string? - Lead Default Contact Phone Number
- address LeademailreceivedeventinfoDataAddress? -
- email LeademailreceivedeventinfoDataEmail? -
- assignedUsers UserListStructure? - Assigned users
iris.subscriptions: LeademailreceivedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadNoteAddedEventInfo![](/images/permalink.svg)
Fields
- hook LeadnoteaddedeventinfoHook? -
- data LeadnoteaddedeventinfoData? -
iris.subscriptions: LeadnoteaddedeventinfoData![](/images/permalink.svg)
Fields
iris.subscriptions: LeadnoteaddedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadRestoredEventInfo![](/images/permalink.svg)
Fields
- hook LeadrestoredeventinfoHook? -
- data LeadrestoredeventinfoData? -
iris.subscriptions: LeadrestoredeventinfoData![](/images/permalink.svg)
Fields
- lead record { restoredAt string?, restoredBy UserStructure? }? -
- leads record { restoredAt string?, restoredBy UserStructure? }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeadrestoredeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadStatusUpdatedEventInfo![](/images/permalink.svg)
Fields
- hook LeadstatusupdatedeventinfoHook? -
- data LeadstatusupdatedeventinfoData? -
iris.subscriptions: LeadstatusupdatedeventinfoData![](/images/permalink.svg)
Fields
- lead record { previousStatus record { id int?, name string? }, newStatus record { id int?, name string? }, statusUpdatedAt string?, statusUpdatedBy UserStructure?, salesRep UserStructure? }? -
- leads record { previousStatus record { id int?, name string? }, newStatus record { id int?, name string? }, statusUpdatedAt string?, statusUpdatedBy UserStructure?, salesRep UserStructure? }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeadstatusupdatedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LeadUpdatedEventInfo![](/images/permalink.svg)
Fields
- hook LeadupdatedeventinfoHook? -
- data LeadupdatedeventinfoData? -
iris.subscriptions: LeadupdatedeventinfoData![](/images/permalink.svg)
Fields
- lead record { updated_at string?, updated_by UserStructure? }? -
- leads record { updated_at string?, updated_by UserStructure? }[]? - 'leads' property is passed when 'Multiple at once' feature is enabled
iris.subscriptions: LeadupdatedeventinfoHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LineItemAdded![](/images/permalink.svg)
Fields
- hook LineitemaddedHook? -
- data LineitemaddedData? -
iris.subscriptions: LineitemaddedData![](/images/permalink.svg)
Fields
- line_items LineItems[]? -
iris.subscriptions: LineitemaddedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: LineItems![](/images/permalink.svg)
Fields
- id int? -
- 'type string? -
- item_id int? -
- user LineitemsUser? -
- merchant LineitemsMerchant? -
- related_mid int? -
- related_dba string? -
- description string? -
- income int? -
- expense int? -
- percentage int? -
- agent_net int? -
- is_recurring boolean? -
- created string? - Created date of line item
- modified string? - Last update date of line item
- agents LineitemsAgents[]? -
- recurring_start_date string? - Date of start recurring line item
- recurring_payment_count int? - Count of payments what was already done
- recurring_max_payment_count int? - Count of payments which will be done (this will be null if there is no limit)
- recurring_period string? -
iris.subscriptions: LineitemsAgents![](/images/permalink.svg)
Fields
- user_id int? -
- username string? -
- full_name string? -
- agent_net int? -
- percentage int? -
iris.subscriptions: LineitemsMerchant![](/images/permalink.svg)
Fields
- mid string? -
- dba string? -
iris.subscriptions: LineitemsUser![](/images/permalink.svg)
Fields
- user_id int? -
- username string? -
- full_name string? -
- 'class string? -
iris.subscriptions: Links![](/images/permalink.svg)
Fields
- first string? - An URL to the first page of the data set
- last string? - An URL to the last page of the data set
- prev string? - An URL to the previous page of the data set
- next string? - An URL to the next page of the data set
iris.subscriptions: Meta![](/images/permalink.svg)
Fields
- current_page int? - The current page number of a data set
- 'from int? - The current position of a data set
- last_page string? - The last page of a data set
- path string? - API path
- per_page int? - A number of records per page
- to int? - The last position in a data set
- total int? - Total number of records in a data set
iris.subscriptions: ReportPublished![](/images/permalink.svg)
Fields
- hook ReportpublishedHook? -
- data ReportpublishedData? -
iris.subscriptions: ReportpublishedData![](/images/permalink.svg)
Fields
- reports ReportpublishedDataReports[]? -
iris.subscriptions: ReportpublishedDataReports![](/images/permalink.svg)
Fields
- id int? -
- month int? -
- year int? -
- sys_prin int? -
- created string? - Ticket created date
- created_by UserStructure? -
- added_merchants_count int? -
- rows_count int? -
- revision int? -
- deactivated_merchants_count int? -
- processor_id int? -
- processor_name string? -
- sum_transactions int? -
- sum_volume decimal? -
- sum_net decimal? -
- sum_agent_net int? -
iris.subscriptions: ReportpublishedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: RetrievalAdded![](/images/permalink.svg)
Fields
- hook RetrievaladdedHook? -
- data RetrievaladdedData? -
iris.subscriptions: RetrievaladdedData![](/images/permalink.svg)
Fields
- retrievals RetrievalsReplyResponse[]? -
iris.subscriptions: RetrievaladdedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: RetrievalReminder![](/images/permalink.svg)
Fields
- hook RetrievalreminderHook? -
- data RetrievalreminderData? -
iris.subscriptions: RetrievalreminderData![](/images/permalink.svg)
Fields
- retrievals record { due_in int? }[]? -
iris.subscriptions: RetrievalreminderHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: RetrievalsReplyResponse![](/images/permalink.svg)
Fields
- retrieval RetrievalsreplyresponseRetrieval? -
- Fields Included from *DisputeDetailsResponse
- transactions DisputedetailsresponseTransactions[]|()
- auth_records DisputedetailsresponseTransactions[]|()
- notes DisputedetailsresponseNotes[]|()
- messages DisputedetailsresponseMessages[]|()
- directories DisputedetailsresponseDirectories[]|()
- anydata...
iris.subscriptions: RetrievalsreplyresponseRetrieval![](/images/permalink.svg)
Fields
- id string? -
- merchant_id string? -
- dba string? -
- date string? -
- transaction_date string? -
- amount string? -
- reason_code string? -
- reason string? -
- card_number string? -
- case_number string? -
- case_action string? -
- action string? -
- case_status string? -
- case_status_description string? -
- last_status_date string? -
- respond_due string? -
- original_amount string? -
- updated_at string? -
- mcc string? -
- dispute_jurisdiction string? -
- card_product_type string? -
- foreign_amount string? -
- transaction_method string? -
- transaction_locator string? -
- invoice_number string? -
- microfilm_number string? -
- airline_ticket_number string? -
- order_number string? -
- tracking_number string? -
iris.subscriptions: RetrievalUpdated![](/images/permalink.svg)
Fields
- hook RetrievalupdatedHook? -
- data RetrievaladdedData? -
iris.subscriptions: RetrievalupdatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: ShortLeadSubscription![](/images/permalink.svg)
Fields
- id int? - Lead ID
- lead_url string? - Lead URL
- name string? - Lead Name
- email string? - Lead Default Email
- contact string? - Lead Default Contact Name
- phone string? - Lead Default Contact Phone Number
- address LeademailreceivedeventinfoDataAddress? -
- assignedUsers UserListStructure? - Assigned users
iris.subscriptions: SignatureGenerated![](/images/permalink.svg)
Fields
- hook SignaturegeneratedHook? -
- data SignaturegeneratedData? -
iris.subscriptions: SignaturegeneratedData![](/images/permalink.svg)
Fields
- signatures SignaturegeneratedDataSignatures[]? -
iris.subscriptions: SignaturegeneratedDataSignatures![](/images/permalink.svg)
Fields
- signature SignatureSubscription? -
- application ApplicationSubscription? -
- lead FullLeadSubscription? -
iris.subscriptions: SignaturegeneratedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: SignatureOpened![](/images/permalink.svg)
Fields
- hook SignatureopenedHook? -
- data SignaturegeneratedData? -
iris.subscriptions: SignatureopenedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: SignatureSigned![](/images/permalink.svg)
Fields
- hook SignaturesignedHook? -
- data SignaturegeneratedData? -
iris.subscriptions: SignaturesignedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: SignatureSubscription![](/images/permalink.svg)
Fields
- id int? -
- hash string? -
- url string? -
- status string? -
- created string? - Signature created date
- created_by UserStructure? -
- multi_signer boolean? -
- completed boolean? -
- signers SignaturesubscriptionSigners[]? -
iris.subscriptions: SignaturesubscriptionSigners![](/images/permalink.svg)
Fields
- name string? -
- email string? -
iris.subscriptions: SubscriptionCommentEdited![](/images/permalink.svg)
Fields
- hook SubscriptioncommenteditedHook? -
- data TicketcommentedData? -
iris.subscriptions: SubscriptioncommenteditedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TestSubscription![](/images/permalink.svg)
Fields
- hook TestsubscriptionHook? -
- data TestsubscriptionData? -
iris.subscriptions: TestsubscriptionData![](/images/permalink.svg)
Fields
- message string? -
iris.subscriptions: TestsubscriptionHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: Ticket![](/images/permalink.svg)
Fields
- id int? - Ticket id
- subject string? - Ticket subject
- description string? - Ticket description
- status TicketStatus? -
- 'type TicketType? -
- 'group TicketGroup? -
- priority TicketPriority? -
- lead_id int? - Assigned Lead ID
- mid int? - Assigned Merchant ID
- merchantVisible boolean? - Indicates if the ticket is visible to Merchant users
iris.subscriptions: TicketCommented![](/images/permalink.svg)
Fields
- hook TicketcommentedHook? -
- data TicketcommentedData? -
iris.subscriptions: TicketcommentedData![](/images/permalink.svg)
Fields
- comments record { id int?, ticketId int?, comment string?, created string?, createdBy UserStructure?, modified string?, modified_by UserStructure? }[]? -
iris.subscriptions: TicketcommentedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TicketCreated![](/images/permalink.svg)
Fields
- hook TicketcreatedHook? -
- data TicketcreatedData? -
iris.subscriptions: TicketCreatedBlock![](/images/permalink.svg)
Fields
- created string? - Ticket created date
- created_by int? - Ticket creator id
iris.subscriptions: TicketcreatedData![](/images/permalink.svg)
Fields
- tickets record {}[]? -
iris.subscriptions: TicketcreatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TicketGroup![](/images/permalink.svg)
Fields
- id int? - Group id
- name string? - Group name
iris.subscriptions: TicketPriority![](/images/permalink.svg)
Fields
- id int? - Priority id
- name string? - Priority name
iris.subscriptions: TicketResolved![](/images/permalink.svg)
Fields
- hook TicketresolvedHook? -
- data TicketresolvedData? -
iris.subscriptions: TicketresolvedData![](/images/permalink.svg)
Fields
- tickets record { created string?, created_by UserStructure?, modified string?, modified_by UserStructure?, last_comment string?, resolved string?, resolved_by UserStructure? }[]? -
iris.subscriptions: TicketresolvedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TicketStatus![](/images/permalink.svg)
Fields
- id int? - Status id
- name string? - Status name
iris.subscriptions: TicketSubscriptionData![](/images/permalink.svg)
Fields
- ticket_url string? -
- assignedUsers UserListStructure? - Assigned users
- files File[]? -
- preview_images File[]? -
- due_date string? - Ticket due date
- due string? - Ticket SLA
- only_business_days boolean? - Calculate only business days
iris.subscriptions: TicketType![](/images/permalink.svg)
Fields
- id int? - Type id
- name string? - Ticket type
iris.subscriptions: TicketUpdated![](/images/permalink.svg)
Fields
- hook TicketupdatedHook? -
- data TicketupdatedData? -
iris.subscriptions: TicketupdatedData![](/images/permalink.svg)
Fields
- tickets record { modified string?, modified_by UserStructure?, last_comment string? }[]? -
iris.subscriptions: TicketupdatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TurboAppApproved![](/images/permalink.svg)
Fields
- hook TurboappapprovedHook? -
- data TurboappapprovedData? -
iris.subscriptions: TurboappapprovedData![](/images/permalink.svg)
Fields
- accounts TurboappapprovedDataAccounts[]? -
iris.subscriptions: TurboappapprovedDataAccounts![](/images/permalink.svg)
Fields
- id int? - Account ID
- application_url string? - Application URL
- identifier string? - Application identifier
- processor string? - Processor name
- dba string? - Merchant name
- mid int? - Merchant ID
- lid int? - Lead ID related to the application
- activation_status TurboappupdatedDataActivationStatus? -
- application_status TurboappupdatedDataActivationStatus? -
- contact_name string? -
- contact_address string? -
- contact_phone string? -
- salesman string? -
- co_name string? -
- approved_at string? - Date and time of account approve (ISO 8601)
- legal_name string? - Merchant name
- comments TurboappupdatedDataComments? -
- entitlements TurboappapprovedDataEntitlements? -
- users string[]? -
- date_submitted string? - Date and time of account submit (ISO 8601)
- date_decision string? - Date and time of decision (ISO 8601)
- mcc_code string? - MCC code
- annual_sales string? - Annual sales
- average_ticket string? - Average ticket
- tier string? -
- tier_status string? -
iris.subscriptions: TurboappapprovedDataEntitlements![](/images/permalink.svg)
Fields
- card_type string? -
- srv string? -
- proc_flag string? -
iris.subscriptions: TurboappapprovedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TurboAppDeclined![](/images/permalink.svg)
Fields
- hook TurboappdeclinedHook? -
- data TurboappdeclinedData? -
iris.subscriptions: TurboappdeclinedData![](/images/permalink.svg)
Fields
- accounts TurboappdeclinedDataAccounts[]? -
iris.subscriptions: TurboappdeclinedDataAccounts![](/images/permalink.svg)
Fields
- id int? - Account ID
- application_url string? - Application URL
- identifier string? - Application identifier
- processor string? - Processor name
- dba string? - Merchant name
- mid int? - Merchant ID
- lid int? - Lead ID related to the application
- activation_status TurboappdeclinedDataActivationStatus? -
- application_status TurboappdeclinedDataActivationStatus? -
- contact_name string? -
- contact_address string? -
- contact_phone string? -
- salesman string? -
- co_name string? -
- declined_at string? - Date and time of account was declined (ISO 8601)
- legal_name string? - Merchant name
- comments TurboappdeclinedDataComments? -
- entitlements TurboappapprovedDataEntitlements? -
- users string[]? -
- date_submitted string? - Date and time of account submit (ISO 8601)
- date_decision string? - Date and time of decision (ISO 8601)
- mcc_code string? - MCC code
- annual_sales string? - Annual sales
- average_ticket string? - Average ticket
- tier string? -
- tier_status string? -
iris.subscriptions: TurboappdeclinedDataActivationStatus![](/images/permalink.svg)
Fields
- old string? -
- 'new string? -
iris.subscriptions: TurboappdeclinedDataComments![](/images/permalink.svg)
Fields
- date string? - Date and time of comment (ISO 8601)
- co string? -
- text string? -
iris.subscriptions: TurboappdeclinedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TurboAppSubmited![](/images/permalink.svg)
Fields
- hook TurboappsubmitedHook? -
- data TurboappsubmitedData? -
iris.subscriptions: TurboappsubmitedData![](/images/permalink.svg)
Fields
- applications TurboappsubmitedDataApplications[]? -
iris.subscriptions: TurboappsubmitedDataApplications![](/images/permalink.svg)
Fields
- id int? - Application ID
- application_url string? - Application URL
- identifier string? - Application identifier
- submission_id string? - Application submission identifier
- dba string? - Merchant name
- lid int? - Lead ID related to the application
- createdAt string? - Date and time of creation (ISO 8601)
- createdBy UserStructure? -
- finishedAt string? - Date and time of submission (ISO 8601)
- finishedBy UserStructure? -
iris.subscriptions: TurboappsubmitedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: TurboAppUpdated![](/images/permalink.svg)
Fields
- hook TurboappupdatedHook? -
- data TurboappupdatedData? -
iris.subscriptions: TurboappupdatedData![](/images/permalink.svg)
Fields
- accounts TurboappupdatedDataAccounts[]? -
iris.subscriptions: TurboappupdatedDataAccounts![](/images/permalink.svg)
Fields
- id int? - Account ID
- application_url string? - Application URL
- identifier string? - Application identifier
- dba string? - Merchant name
- mid int? - Merchant ID
- lid int? - Lead ID related to the application
- comments TurboappupdatedDataComments? -
- activation_status TurboappupdatedDataActivationStatus? -
- application_status TurboappupdatedDataActivationStatus? -
- contact_name string? -
- salesman string? -
- updatedAt string? - Date and time of account update (ISO 8601)
iris.subscriptions: TurboappupdatedDataActivationStatus![](/images/permalink.svg)
Fields
- old string? -
- 'new string? -
iris.subscriptions: TurboappupdatedDataComments![](/images/permalink.svg)
Fields
- date string? - Date and time of comment (ISO 8601)
- co string? -
- text string? -
iris.subscriptions: TurboappupdatedHook![](/images/permalink.svg)
Fields
- requestId int? - Request ID
- event string? - Event ID
iris.subscriptions: UserStructure![](/images/permalink.svg)
Fields
- id int? - User ID
- name string? - User Name
- userClass string? - User Class
Import
import ballerinax/iris.subscriptions;
Metadata
Released date: over 1 year ago
Version: 1.3.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Paid
Contributors
Dependencies