⚙️ Siena Custom Integrations

Welcome to Siena custom integrations! This guide is your roadmap for successfully setting up and navigating your own custom integrations, opening up a world of possibilities for connecting existing APIs and initiating actions across any system. Let's dive in!

Steps for set up

1. Under Modules, click on Custom Integrations. Then click New integration to get started.
   
   
   
2. Now name your integration and, if you’d like, upload an image so you can quickly find your integration across the platform. When you're happy with it, click Save.
   
   
   
3. Congratulations! You just set up your first integration.You can then see the name, image and date created. In order to complete the set-up, you need to add Actions to your custom integration. Click New action to get started.
   
   
   
4. Now you will see we have a 3 step form. You need to complete the form with details in every field.
   • First step, fill out the following: Action Name, HTTP method, Endpoint URL. All fields are mandatory.
     • Action name → Name for your action
     • HTTP method → We support GET , POST, PUT , PATCH, and DELETE methods. You can pick the one that fits your endpoint method type.
     •  Endpoint URL → Provide your API endpoint url for the above method.
       
       
       
   • Next, Authentication details. We recommend that each action have Authentication set up in order to have a secure connection.
     • Type → Select the type of Authentication. Currently we only offer Api Key.
     • Api Key → Provide the Api Key for your authentication. Ex: Bearer ....your token
     • Api key header name → Provide the header name. Ex: Authorization
       
       
       
   • Finally, set up the configuration.
     • Payload configuration → Add any data that you want to send to your api inside the body by clicking Add . Ex. body: cancelOrder:true.
       
       
       
       
     • Admin instructions → Write how you want Siena to run this action. Ex. Replace {order_id} with the specific order ID provided.
     • Success message → This is the success message presented when the action is successfully completed by Siena.
     • Error message → This is the error message presented when the action fails.
       
       
5. Click Save. You should see your newly set up action under your custom integration!
   
   
   
6. Click on the action to see the details or edit any of the fields.
   

Test actions

1. Add your action to the specific automation. You will see your newly created custom integration under the Integration dropdown. You can then select an associated Action.
   
   
   
2. Save your automation. Now every time the automations runs, we execute the Custom Action as well.
   
   
   
3. Test your automation in the Playground 🎉
   

More information

• Note: Any retrieved data from a GET request action is always available as context for Siena when generating responses. Therefore a GET action is not attached to a specific automation.
• For all other types of requests, actions need to be added to a specific automation to be executed.

We hope this guide has been helpful in setting up your Siena Custom Integrations. If you have any further questions or need assistance, please don't hesitate to reach out to our Customer Support team. We're always here to help!