Outgoing webhook

To be able to use outgoing integrations with the external systems in a journey, follow the procedure described below.

Requirements


If you want to create an integration that sends data, prepare a schema for the webhook body in the Schema Builder.

Procedure


  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 webhook 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.
  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.
  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.
  10. In the Parameters section, click Define.
  11. From the Schema template drop-down list, select a schema created earlier in the Schema Builder.
  12. Click Apply.
  13. In the Webhook body section, click Define.
  14. In the Body text box, enter the JSON payload schema.
    This JSON schema can include inserts.
  15. 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.
  16. Click Apply.
  17. In the upper-right corner, click Build test.
    The Build test pop-up opens.
  18. In the Client context field, select a customer.
  19. In the Schema object form field, enter the data to be sent in the payload, if applicable.
  20. Click Preview.
  21. In the view that opens, review the JSON content of the webhook.
  22. Click Send.
    Result: A test webhook request is made.
  23. 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 webhook 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.