What is a webhook?
Webhooks, also known as http callbacks, are a way for Street to notify your external applications that a specific event has occurred without these applications having to submit a request.
Another way to think about webhooks is that they are push notifications between your CRM and your other external applications. Street detects that an event has occurred inside the CRM which triggers the CRM to send a response to the external application
How to use webhooks inside of Street
To get started, you will need to navigate to Settings (left side panel at the bottom) > Account Administration section > Webhooks.
It is important to note, if you do not have this option to get into contact with the Street Support team who can enable it for you.
Once there you will be greeted by a page with the following options: Endpoints, Event, Catalog Logs, Activity
Endpoints
On the endpoints page you can see all of your currently registered endpoints as well as adding a new one.
Adding a new endpoint
To add a new endpoint, click the "+ Add Endpoint button". After you click that you will then be presented with a page with all the information to register your endpoint such as the endpoint URL, where the webhook will deliver the 'alerts'. This is something you will need to decide with your web developer on where these alerts will be delivered.
You will also see a description, where you can give more detail on what this webhook does. You can then tick which events this webhook will be subscribed to.
If you want more information about what events you can subscribe to, check out the Event Catalog.
In the advanced config page you can enable rate limiting.
If you want to configure custom headers for the endpoint, you will have to do so from the endpoint details page after it's created.
Viewing an endpoint
Once you have created the endpoint, if you click into the box you will be greeted with information all about that current endpoint, included successful deliveries, and a log of all sent alerts.
Event catalog
In the event catalog, you will be able to see all events that are able to be subscribed to and how that alert will look, when delivered to the endpoint.
Logs
In the logs page, you can see an historic list of all sent alerts. You can also filter this down more with the filter Icon on the right of the page. You can also jump to a message if you know the messageID.
Activity
Here you can see a graph for the last 6 hours of successful and failed deliveries.
Information for Developers
You can find out webhook documentation here.