Module 13: Integrating Other Systems with Rise-X

Introduction to Integrations 🔗

Rise-X is designed to seamlessly integrate with external systems, enabling you to automate workflows, sync data, and enhance collaboration across platforms. Whether you’re connecting to ERPs, CRMs, databases, or third-party tools like Zapier, Rise-X provides flexible integration options to fit your needs.

Key Integration Methods 🤔

• Use the Publish External Data Activity to integrate with Zapier: Connect Rise-X to thousands of apps using Zapier webhooks.
• Use the Publish External Data activity to connect to other systems: Send data from Rise-X to external systems.
• Rise-X APIs: Receive data back into Rise-X and trigger actions to happen on your ecosystem programmatically or by a trigger in another system.

Using the Publish External Data Activity to Integrate with Zapier ⚡️

Overview:

The Publish External Data Activity allows you to automatically send data from Rise-X to an external system via a webhook or API endpoint. Activities are triggered when a task in a workflow is submitted.

Steps to Set Up:

1. On Zapier create a new zap and then select the trigger to be a webhook.
1. This requires Zapier premium.
2. Copy the webhook address and save it for later.
1. e.g. “https://hooks.zapier.com/hooks/catch/123456789/qwerty/”.
3. Create a new or use an existing workflow on Rise-X.
1. This requires ecosystem orchestrator or workflow owner permission.
4. Add in a text field.
1. Either using the No-Code Builder or the Advanced Editor.
5. Navigate to the text field in the Advanced Editor.
1. Open the advanced editor then go to.
1. e.g. Steps > {step name} > {task name} > Layouts > {layout name} > {section name} > {text component name}
6. Copy the “dataPath” property value of the text component and save it for late.
1. One of the properties of the text component is the “dataPath” property.
2. Copy the value of this and save it for later.
3. e.g. copy “$.task.section.textComponent” from “dataPath”: “$.task.section.textComponent”
7. Navigate to the task that the text component is in.
1. Open the advanced editor then go to.
2. e.g. Steps > {step name} > {task name}
8. Copy the “name” property value of the task and save it for later.
1. One of the properties of the task is the “name” property.
2. Copy the value of this and save it for later.
3. e.g. “ecosystemName/workflow/entity/generated-8eb85834-78c7-4361-8604-5aa70856fed1/untitledstep__generated-5cb4512c-484f-4b59-b2bb-0223b1667c56/untitledtask__generated-cb68e3de-b9ca-4e09-8d9d-47347f8c7b12”
9. Create the Activity.
• Open the advanced editor then go to the activities group of the button on the task you want to trigger the data sending activity.
• e.g. Steps > {step name} > {task name} > Action Set > {action name} > Activities
• Add a Publish External Data Activity to the task you want to trigger the data send by hovering over “Activities” > clicking the ellipsis > “Add activity” > “Publish External Data”.
10. Set up these properties on the Publish External Data Activity.
• “publishIdentity”: {}
• “endPointUri”: Paste the Zapier webhook address.
• “httpMethod”: “POST”
• “AuthType”: “BASIC”
• “operations”:[{}]
• “sectionName”: Paste the task “name”.
• “dataMapping”: {}, {} (You can include many components in your data mapping and each goes in it’s own {})
• “fromPath”: The data path of the component.
• “toProperty”: The label that you want for this data as it gets received to Zapier.
• “updateType”: “Push”
• “targetPath”: The first part of the data path from a component in the dataMapping (e.g. if the data path is $.task.section.textComponent then you would put “$.task.section” as your targetPath value).
• “dataType”: “Object”
• “target”: 1
• “sectionName”: Paste the task “name”.
11. Example of the set up configuration for the Publish External Data Activity.
Copy

  {
  "continueOnError": false,
  "executeWhen": "AfterExecute",
  "runOnSystemEvents": [],
  "properties": {
    "publishDataDirection": "ToRelatedEntity",
    "publishIdentity": {
      "endPointUri": "https://hooks.zapier.com/hooks/catch/123456789/qwerty/",
      "httpMethod": "POST",
      "authType": "BASIC"
    },
    "operations": [
      {
        "sectionName": "ecosystemName/workflow/entity/generated-8eb85834-78c7-4361-8604-5aa70856fed1/untitledstep__generated-5cb4512c-484f-4b59-b2bb-0223b1667c56/untitledtask__generated-cb68e3de-b9ca-4e09-8d9d-47347f8c7b12",
        "dataMapping": [
          {
            "fromPath": "$.taskName.textComponent",
            "toProperty": "text data"
          },
          {
            "fromPath": "$.taskName.numberComponent",
            "toProperty": "number data"
          }
        ],
        "updateType": "Push",
        "targetPath": "$.taskName",
        "dataType": "Object",
        "excludeProperties": []
      }
    ],
    "target": 1,
    "sectionName": "ecosystemName/workflow/entity/generated-8eb85834-78c7-4361-8604-5aa70856fed1/untitledstep__generated-5cb4512c-484f-4b59-b2bb-0223b1667c56/untitledtask__generated-cb68e3de-b9ca-4e09-8d9d-47347f8c7b12"
  }
}

12. Publish the workflow.
13. Test the Integration.
• Create a new work item.
• Fill in data for the text component in the work item.
• Submit the task.
• You can now go back to Zapier and test the webhook and you should see a new entry having been sent to the webhook and inside this entry will be the value in the text component.
14. Done 🎉

Integrating with Other Systems 🛠️

You can also use the publish external data activity to send data from Rise-X to any other external address. You can then use Rise-X’s open APIs to send data and trigger actions back on the Rise-X system.

Using Rise-X APIs 💻

Overview:

Rise-X APIs allow you to programmatically interact with workflows, assets, and data. This is ideal for custom integrations or advanced automation. To get more information about how to use these end points see the “API Documentation” section on the knowledge base.

Key Endpoint functionality:

1. Authentication:
• Get a bearer token using your user ID and API key.
2. Get work item data:
• Get data from a specific work item or asset.
3. Get workflow or asset type data:
• Retrieve workflow or asset type details.
4. Create:
• Start a new work item or create an asset.
5. Update:
• Update data in an existing work item or asset.
6. Submit:
• Submit a task in a work item or save an asset.

Using APIs with Zapier:

• You can use Zapier webhooks as an action in a zap to send data back to Rise-X

Key Takeaways 🔑

• Rise-X is open for integrating with other systems.
• Basic integrations can be achieved using Zapier while more advanced integrations can be achieved using the Advanced Editor and our open APIs.

Continue Learning 🚶‍♀️‍➡️

• The next module in the Rise-X Academy covers how to start using Rise-X, check it out here.