Outbound Webhooks
If you need to send data to a vendor not in our current integration list, you can do this right in Simon by using the Webhook Channel Action, no code needed.
What is a Webhook and why use one?
You may have heard a lot of talk about using webhooks to connect to other applications, after all they are developed by most applications today. But what are they really and how does Simon use them?
Webhooks allow one application to talk to another; in Simon's case we can send a message to another application containing information about whatever Simon related events you want us to. Want to update contact lists? You got it. Want to let another application know what city your customer is in? You can do that too. All in real-time!
Basic webhook calls are fairly simple to build and make right from Simon, no code need! However, there are some more advanced and complex use cases that require a little more technical knowledge; if you're interested in trying some of those out tag an engineer friend in and check out our developers docs to learn more. There are also a lot of great free resources to learn about webhooks and APIs if you search the web.
Terms to Know
| Term | Definition |
|---|---|
| Authentication | Authentication is how the destination for your message securely accepts your message (payload). You may need your user login and password, or another type of credential called a Client ID and/or Client Secret. See Authentication for more detail. |
| Call/Request | This is the action your webhook makes to actually communicate with your receiver and send it a message. We say, "calling the endpoint," or "making a call." It's sometimes called a request too. |
| Endpoint | This is the URL for your receiver application, like calling a friend's phone number except via internet standards. Your destination will provide this address in their documentation. |
| HTTP Protocol | Very simply put, these are the rules the world wide web, APIs, and Webhooks use to communicate with each other successfully so you can see information. |
| Method | This refers to the type of request you're sending to an endpoint and what the receiver needs to do with the data. For example, updating, deleting, etc. |
| Payload | This is the body of your request. Much like the body of a letter, it contains the data you're sending to the endpoint. You specify what fields you want sent over, and the payload contains the respective data. |
| Pipedream | Pipedream is a tool used to develop APIs, but it can also be used to call endpoints and test payloads. Check with you organization to see if it's a tool you can use. |
| Postman | Postman is a tool used to develop APIs, but it can also be used to call endpoints and test payloads. Check with you organization to see if it's a tool you can use. |
We're Talking Outbound Webhooks Only Here
This guide focuses on outbound webhooks intended to sent data out from Simon to another endpoint.
Before You Begin
Application Webhook Documentation
You need to reference the webhook or API documentation for your destination, sometimes known as an API reference. You need to refer to their documentation throughout this process to know what to enter in each field and what their individual requirements for sending are. You can usually find this documentation via that vendor's website, in their product documentation, or by performing a quick internet search.
Webhook and API documentation can vary by vendor, but generally have these similarities that you'll find useful:
- An overview or summary of what the endpoint is intended for. Sometimes this summary is followed by some child pages for each method type. In most cases with webhooks from Simon, you're looking for a
POSTmethod.- Confirm with the summary that this endpoint will perform the function you want it to based on your use case (i.e. accept contact data from another source, sync a contact list, etc.).
- An endpoint URL. You're looking for the HTTP URL to send your message to. It'll be different for each endpoint the webhook or API offers so be sure to choose the correct one.
- Information about authentication, parameters, encoding: these are all things you need to know to send your webhook action successfully. See Create a Webhook for more detail.
You may have to scan through the document a couple times if you're not familiar with API References or similar technical documents. If you need help, ask an engineer or IT support on your team, or feel free to contact your Simon account manager.
Allow the Receiver's Domain
To make a webhook call, you first have to register your receiver's domain (URL). Find this domain in your destination's webhook/API documentation (see above).
15 Domains Max, Contact Your Account Manager for More Details
You can register 15 domains max.
If you insert a new domain into a field that already contains an endpoint, you will overwrite the previous domain.
To add the domain:
- As an admin, log in to Simon.
- From the left navigation, expand Admin Center then click Integrations.
- Scroll to the webhooks icon (see image below) then enter the domain in the correct field (see warning above).
- Click Save.
Learn more
Want to learn more about webhooks in general? Here are some of our favorite videos:
Updated 8 months ago