Outgoing integration

The Outgoing integration module allows any external service to be integrated with Synerise. Thanks to the possibility of building HTTP requests and supplementing them with any dynamic customer attributes or data calculated by the Analytics module, you can synchronize data by sending them in or out of Synerise.

Note:

The following use cases offer practical examples of combining schemas and outgoing integrations:

Prerequisites


Optional: To use the integration in a more user-friendly way, you can prepare a schema frist for the webhook body in the Schema Builder, so the data required in the Outgoing integration are visually presented.

Define the endpoint


  1. Go to Automation icon Automation > Outgoing.
  2. In the upper-right corner of the screen, click New integration.
    The template creation page opens.
    Outgoing integration creation page
    Outgoing integration creation page
    Tip: At any point of the procedure, if you want to save unfinished work for later, click the Finish later button in the upper-right corner of the screen.
  3. In the upper-left corner of the screen, enter a name for the integration.
  4. In the Define section, click Define.
    Outgoing integration creation page
    Outgoing integration creation page
  5. From the URL drop-down list, select an HTTP method.
  6. In the URI address field, enter the endpoint.
    The URI can contain inserts.
    WARNING: This field doesn’t allow the endpoints defined as IPs (for example, 51.145.180.18). You can only use endpoints that contain a domain (for example, https://example.com)
  7. Optional: Upload an icon for the node.
  8. Optional: In the Event action name field, enter the name of the event logged when the node is triggered.
    The name can include inserts.
    If you leave the field blank, the action defaults to webhook.response.
  9. Click Apply.

Select the schema template


Outgoing integration creation page
Outgoing integration creation page
Note: This step is optional. You don’t have to choose any schema.
  1. In the Parameters section, click Define.
  2. From the Schema template drop-down list, select a schema created earlier in the Schema Builder.
  3. Click Apply.

Enter the request body


Outgoing integration creation page
Outgoing integration creation page
  1. In the Webhook body section, click Define.
  2. In the Body text box, enter the JSON payload schema.
    This JSON schema can include inserts.
  3. In the Header sub section, add headers in the following way:
    1. In the Key field, enter the header name.
    2. In the Value field, enter the header value.
      The key and value can contain inserts.
    3. If you want to add more headers, click Add header.
  4. In the **Authorizaton sub-section, select one of the following methods:
    • Basic access
    • By token
    • By API key - This method is especially useful to the users who use Synerise REST API. When you choose this authorization method, from the dropdown list, you can select an API key with required permissions available in the business profile. This way the requests to Synerise API are executed by means of this integration and JWT token is not required as it is generated while sending requests and attached to the request.
  5. Click Apply.
  6. In the upper-right corner, click Build test.
    The Build test pop-up opens.
  7. In the Client context field, select a customer.
  8. In the Schema object form field, enter the data to be sent in the payload, if applicable.
  9. Click Preview.
  10. In the view that opens, review the JSON content of the webhook.
  11. Click Send.
    Result: A test webhook request is made.
  12. Continue according to the test results:
    1. If the test was successful:
      1. If you want to change something in the integration definition or publish it later, click Close.
        If you make any changes, you must re-run the test.
      2. If you want to start using the integration in automations, click Save & publish.
      3. You can use this integration in the Outgoing Integration node.
    2. If the test failed:
      1. Click Close.
      2. Modify the custom node.
      3. Re-run the test.
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker