1. The platform using access to OpenConnect must be able to establish Ingress and Egress API connections.
   
2. You will need a few pieces of information to authenticate with OpenConnect: JWT Key, CRM ID, Event Name

To trigger the published PopFlow, we must get the event to which it belongs. 

1. Login to Experience Cloud and navigate to the Instance
2. Find the event of the published PopFlow and copy the name exactly (case and length sensitive)

Required

Add each required query parameter. Note each parameter is case-sensitive.

agentid

• The agentid creates the experience at the agent/user level. For example, use your user login for the agentid or use login for the user who will receive the experience.

• Replace insert_api_key with the generated API key from Experience Cloud.

event

• The event is the event's name that will trigger the PopFlow from your Experience Cloud platform.

Optional Data Properties

Pass and include additional data elements in your requests, such as interaction data, custom information, routing, or ACD data.

1. agentid={insert_agentId}&jwt={insert_api_key}&event={name_of_event}

Ex: agentid=123&jwt=456&event=testing123

Add any additional data needed for PopFlow workflow.

1. &prop1={insert_prop1}&prop2={insert_prop2}

All together, it will look like this:

• https://connect.openmethodscloud.com?agentId={insert_agentId}&jwt={insert_api_key}&event={name_of_event}&prop1={insert_prop1}&prop2={insert_prop2}

Payload Size Limitations 

OpenConnect limits the payload size to 128 KB per message due to variable-length encoding. 

Set up the base URL: https://connect.openmethodscloud.com/api/sendmessage/CRM?

1. Then, the body is set up, ensuring the Content-Type is set to application/JSON.
2. Finally, add the required body fields and the additional data for the PopFlow workflow. 

1. {
2.    "agentid": "insert_agentId",
3.    "jwt": "insert_api_key",
4.    "crmid": "insert_crmid",
5.    "event": "insert_event_name",
6.    "insert_prop_1": "insert_prop_1_value",
7.    "insert_prop_2": "insert_prop_2_value",
8.    "insert_prop_3": "insert_prop_3_value",
9. }