Webex Connect

https://help.webexconnect.io/docs/
Admin
Webex Connect is a platform for building and managing customer communication flows across various...
Tokens:495,682
Snippets:4,067
Trust Score:6.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Transaction Channels - Start Node Parameters

Source: https://help.webexconnect.io/docs/debugging

Lists the parameters displayed in the Debug flow of the Start Node for different transaction channels.

```APIDOC
## Transaction Channels - Start Node Parameters

### Description
This section details the parameters that are displayed in the Debug flow of the Start Node for various transaction channels.

### Method
GET

### Endpoint
/websites/help_webexconnect_io/transaction_channels/start_node

### Parameters
#### Query Parameters
- **channel** (string) - Required - The transaction channel (e.g., SMS, Voice, Messenger).

### Response
#### Success Response (200)
- **channel** (string) - The name of the channel.
- **event_in_start_node** (string) - The event associated with the channel in the Start Node.
- **parameters_to_be_shown** (array of strings) - A list of parameters to be shown in transaction logs for the given event and channel.

#### Response Example
```json
{
  "channel": "SMS",
  "event_in_start_node": "Mobile originated -MO",
  "parameters_to_be_shown": [
    "Timestamp",
    "Sender Number",
    "Service Number",
    "Message"
  ]
}
```
```

--------------------------------

### Output Variable Examples

Source: https://help.webexconnect.io/docs/email-node

Examples of output variables from Webex Connect, including timestamps, transaction IDs, delivery statuses, and response data. These examples illustrate the format and content of the data generated by the nodes.

```json
{
  "send.sentDateTime": "2019-06-02T17:17:15.575Z",
  "send.gatewayTid": "[{\"code\":\"1001\",\"transid\":\"48ceebcb-8035-40d0-8f22-3608b915e2b6\",\"description\":\"Queued\"}]",
  "send.deliveryStatusDescription": "Submitted/Delivered/Read.",
  "send.deliveryStatusCode": "101",
  "send.response_data": "[{\"code\":\"1001\",\"transid\":\"48ceebcb-8035-40d0-8f22-3608b915e2b6\",\"description\":\"Queued\"}]",
  "send.response_interactive": ""
}
```

--------------------------------

### Webex Connect Variable Prefixing Example

Source: https://help.webexconnect.io/docs/create-conversation

Illustrates how node IDs are used as prefixes for output variables in Webex Connect. For instance, an output variable 'sms.serviceNumber' from a start node (node ID 2) becomes '$(n2.sms.serviceNumber)'.

```text
Example: sms.serviceNumber is an output variable of start node (node id 2), then the variable becomes $(n2.sms.serviceNumber)
```

--------------------------------

### Create Wallet Landing Page

Source: https://help.webexconnect.io/docs/mobile-wallet-api

This endpoint creates a landing page for wallet passes, providing installation buttons for both Android and Apple devices. Users can then install the pass on their device via this landing page.

```APIDOC
## POST /wallet/[Wallet ID]/landing

### Description
Creates a landing page for wallet passes, allowing users to install passes on their devices for Android or Apple.

### Method
POST

### Endpoint
/wallet/[Wallet ID]/landing

### Parameters
#### Path Parameters
- **Wallet ID** (string) - Required - The unique identifier for the wallet.

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - A nested object containing the data elements and values of the wallet object/pass.
  - **data.barcode.type** (string) - Required - The format of the barcode. Possible values: `AZTEC`, `CODABAR`, `CODE128`, `CODE39`, `DATAMATRIX`, `EAN13`, `EAN8`, `ITF14`, `PDF417`, `PDF417COMPACT`, `QRCODE`, `TEXTONLY`, `UPCA`.
  - **data.barcode.value** (string) - Required - The value to be encoded in the barcode.
  - **data.barcode.altText** (string) - Required - Alternative text for the barcode value.

### Request Example
```json
{
  "data": {
    "barcode": {
      "type": "QRCODE",
      "value": "example_barcode_value",
      "altText": "Example Barcode"
    }
  }
}
```

### Response
#### Success Response (200)
- **landingPageUrl** (string) - The URL of the created landing page.

#### Response Example
```json
{
  "landingPageUrl": "https://api.imimobilewallet.com/api/wallet/12345/landing/xyz789"
}
```
```

--------------------------------

### Receive Node Transaction Log Example

Source: https://help.webexconnect.io/docs/transaction-logs-and-debugging

An example of transaction logs from a Receive node, illustrating the typical structure and data points captured for flow transactions.

```text
Timestamp
AppId
Message
Attachment URL
```

--------------------------------

### Webex Connect Data Field Examples

Source: https://help.webexconnect.io/docs/receive-node

Illustrative examples of various data fields used within the Webex Connect platform. These include unique identifiers for accounts and users, device information, authentication tokens and statuses, transaction IDs, and timestamps.

```text
abc.accountId: 3364d419-4b4a-4f59-a767-ac7e60214baa
abc.deviceAgent: iPhone OS
abc.abcUserId: urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.authToken: AQUxx-v6A7qc4dh-N9ZgCDc38LHKFzFM1zMxiiN1z9hgCo1b17NblPWDih3JSARgcv7cvBzNwSY3f9bgqWoYsmIJByG57UExQ4gw1fT0uCMUFbbPdJUx03rObWhUX47SPj_fI4v_T7ec1Jd3H5AQkzX-rTfJnawVIlC7fd8e-jm4GMxPqlkTjC3zWmmTZOYggdiQWBoj6g7EN0yBV-s0zwVdxE2ix7plbOfCkVo6qDVu6HLk0K3lPAQF5viXNcz9LXc8KHyj7zfjOV2bfUB2H6STkymRggKlC03O8F2RN3iDzK8kQq4-NlLvj_5OuvdKpReOXHFMMN-UCYhjngJ1lwmCKRmPbQ
abc.authStatus: Authenticated
abc.authReplyMessageTitle: Reply message
abc.authReplyMessageAlternateTitle: Reply message
abc.appId: a_636893638318070000
abc.timestamp: 2020-02-28T04:44:15.077Z
service.serviceKey: 54251909-59b9-11ed-9c39-02a06e0e48bf
```

--------------------------------

### Prebuilt Transaction Details - Outbound and Async Events

Source: https://help.webexconnect.io/docs/transaction-logs-and-debugging

Logs for Prebuilt nodes include Resume Key, Request Timestamp, Request URL, Request Data, Response Timestamp, and Response Data. This information is crucial for tracking asynchronous operations and outbound events.

```text
Resume key
Request timestamp
Request URL
Request Data
Response timestamp
Response Data
```

--------------------------------

### Channel Asset Set-Up

Source: https://help.webexconnect.io/docs/supported-file-types-for-channels

Details the supported media types and content types for RCS and WhatsApp asset creation.

```APIDOC
## Channel Asset Set-Up

This section outlines the supported media and content types for asset creation across different channels:

| Channel                  | Media | Supported Content Types |
| :----------------------- | :---- | :---------------------- |
| RCS asset creation       | image | jpg,png                 |
| WhatsAppp asset creation | image | jpg, png                |
```

--------------------------------

### Apple Pay Authentication Token Example (Plain Text)

Source: https://help.webexconnect.io/docs/receive

An example of an authentication token used for Apple Pay transactions. This token is typically generated by the authentication system.

```text
Authtoken: AQUxx-v6A7qc4dh-N9ZgCDc38LHKFzFM1zMxiiN1z9hgCo1b17NblPWDih3JSARgcv7cvBzNwSY3f9bgqWoYsmIJByG57UExQ4gw1fT0uCMUFbbPdJUx03rObWhUX47SPj_fI4v_T7ec1Jd3H5AQkzX-rTfJnawVIlC7fd8e-jm4GMxPqlkTjC3zWmmTZOYggdiQWBoj6g7EN0yBV-s0zwVdxE2ix7plbOfCkVo6qDVu6HLk0K3lPAQF5viXNcz9LXc8KHyj7zfjOV2bfUB2H6STkymRggKlC03O8F2RN3iDzK8kQq4-NlLvj_5OuvdKpReOXHFMMN-UCYhjngJ1lwmCKRmPbQ
```

--------------------------------

### Extract String Slice - imi_strings

Source: https://help.webexconnect.io/docs/evaluate

Extracts a portion of a string, starting from a specified start position and optionally ending before a specified end position. Returns the extracted part as a new string.

```javascript
IMI_STRINGS.slice(<<start>>, <<end>>, <<the_actual_text>>);
```

--------------------------------

### SOQL Query Example for Fetching Salesforce Records

Source: https://help.webexconnect.io/docs/salesforce-node-1

This snippet demonstrates a sample SOQL query used to fetch records from Salesforce. It includes a 'LIMIT' clause to control the number of records returned, which is a recommended practice. The query targets the 'Account' object and selects specific fields.

```soql
SELECT Id, Name FROM Account LIMIT 10
```

--------------------------------

### List Picker Payload Example (JSON)

Source: https://help.webexconnect.io/docs/receive

An example of the JSON payload structure for a List Picker interactive message. It includes details about reply messages, selected items, and other items not selected by the user.

```json
{
  "replyMessage": {
    "imageIdentifier": "9190df46-3054-20e0-f227-1f8f4dd4a2b2",
    "style": "large",
    "alternateTitle": "I6 alone",
    "title": "I6 alone"
  },
  "listPicker": {
    "otherItemCount": 3,
    "selectedItemCount": 1,
    "otherItems": [
      {
        "identifier": "a232323",
        "style": "default",
        "title": "I1",
        "url": "https://s3.amazonaws.com/stagingappleattachment/36e9cb72-15df-486b-8dff-b860fb9fa39d.jpeg",
        "order": "0"
      },
      {
        "identifier": "231231",
        "style": "default",
        "title": "I3",
        "url": "https://s3.amazonaws.com/stagingappleattachment/f6da952f-b346-4e82-a6cc-5020df300f87.jpeg",
        "order": "1"
      },
      {
        "identifier": "21312",
        "style": "default",
        "title": "I4",
        "order": "2"
      }
    ],
    "selectedItems": [
      {
        "identifier": "32423423423",
        "style": "default",
        "title": "I6",
        "order": "1"
      }
    ]
  }
}
```

--------------------------------

### Sample Salesforce Account Record JSON Response

Source: https://help.webexconnect.io/docs/salesforce-node-1

This JSON structure represents a sample response for a Salesforce Account record fetched via the 'Get Record Using SOQL' method. It includes metadata like 'done' and 'totalSize', and an array 'records' containing the actual account data.

```json
{
  "done": true,
  "totalSize": 2,
  "records": [
    {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v65.0/sobjects/Account/001xxxxxxxxxxxxxxx"
      },
      "Id": "001xxxxxxxxxxxxxxx",
      "Name": "Sample Account 1"
    },
    {
      "attributes": {
        "type": "Account",
        "url": "/services/data/v65.0/sobjects/Account/001yyyyyyyyyyyyyyyy"
      },
      "Id": "001yyyyyyyyyyyyyyyy",
      "Name": "Sample Account 2"
    }
  ]
}
```

--------------------------------

### SMS Delivery Receipt JSON Example (Clicked)

Source: https://help.webexconnect.io/docs/rcs-branded-text

This JSON example represents an SMS delivery receipt with the status 'Clicked'. It indicates a successful upgrade to Branded Text, resulting in the message being delivered as RCS basic.

```json
{
  "x-wx-gtrid": "4dda02a9-XXXX-XXXX-XXXX-2a7c1614e0c6",
  "deliveryInfoNotification": {
    "deliveryInfo": {
      "timeStamp": "2025-09-15T16:13:01.504+05:30",
      "Description": "https://www.gmail.com|107.77.224.156",
      "code": "1234",
      "messageCount": "",
      "deliveryChannel": "SMS",
      "upgradeResult": "Upgraded to RCS basic",
      "additionalInfo": "Mozilla\/5.0 (Linux; Android 10; K) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/133.0.0.0 Mobile Safari\/537.36",
      "destination": "+1781XXXX232",
      "destinationType": "msisdn",
      "attemptedUpgradeto": "Branded Text",
      "deliveryStatus": "Clicked"
    },
    "subtid": "",
    "transid": "a81681b9-XXXX-XXXX-XXXX-11b673d4be91",
    "callbackData": "CallBackdata",
    "correlationid": ""
  },
  "dataIntegration": {
    "context": {
      "serviceId": "12326",
      "serviceName": "SMSNMXHTTPService1",
      "flowId": "",
      "flowName": "",
      "messagingAPI": "true"
    },
    "appContext": {
      "tenant_identifier": "connectnmxstagingtenant",
      "Topic": "connectnmxstagingtenantTopic",
      "URL": "b-1.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-3.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096,b-2.dev-campaign-integrat.tefj3j.c20.kafka.us-east-1.amazonaws.com:9096",
      "webhookurl": "https://integrations.imiconnect.co/v1/integration/"
    }
  }
}
```
Tokens:
Raw