A webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately.
To use a webhook, you register a URL with Shape from the external app. That URL is a place within your application that will accept the data and do something with it. You can define in Shape through “Triggers” the situations when you’d like to receive data. Whenever there’s something new, the webhook will send it to your URL.The first step in creating and consuming a Shape webhook is getting the URL to deliver requests to. This is most often done through a backend panel or an API. After creating/gathering the webhook URL, enter any headers or parameters required and choose the data points from Shape that you are requesting.
Start by navigating to “Settings” in the top gradient bar. Next click the dropdown labeled “Integrations” to find the “Manage Webhooks” settings page.
You can create a new outbound webhook by clicking “Add Webhook”.
You will also find 3 pre-made webhooks in your system to get you started. These are set up for you and only need the API call URL for application you are sending data to.
Add a title and description for your webhook. The title will be important if setting up triggers for your webhook.
If your webhook requires any headers or parameters (like application type or required authentication codes or fields) add them to these fields.
The most important parts of the webhook involve the API Call URL. This is where you input the URL to which Shape will be sending information. Please be sure this URL is secure.
An example URL being the catch hook URL that is provided in Zapier. When you set up a catch hook in Zapier, a unique URL is generated to receive the data and that URL will go in the API Call URL field in Shape if connecting Shape to Zapier.
Choose the “Type” of information you will be sending. Select “Field”, “File”, or “Field+File”.
You will also find the “Fields” dropdown to choose what Shape data fields are being sent out.
*Note: To utilize Shape API calls (like status updates or getting information, you’ll need to send out the ID field)
Note: Webhooks deliver data to your application and may stop paying attention after making a request. This means if your application has an error your data may be lost.
Webhooks can make a lot of requests. If your provider has a lot of events to tell you about, they may end up DDoSing your app. Make sure your application can handle the expected scale of your webhook.
Shape’s webhooks are designed to send Lead Data out of Shape to an outside application. You will find a list of fields available to send on the webhooks settings page.
If there is a field that you do not find on this page, you will likely need access to our open API for this data. Please reach out to firstname.lastname@example.org for assistance with this.
The outbound webhooks settings page is utilized for sending data OUT of Shape and cannot be used to send data INTO Shape.
Shape offer’s posting URL’s for you lead providers to send data into Shape.
Marketing Sources Posting URL Guide:https://setshape.com/support-guides/marketing-sources
This is most commonly due to the trigger not being set to ON to send the webhook to your outside application.
Please reach out to email@example.com and our dedicated support team will be more than happy to diagnose what may have occurred here!
Keywords: outbound, webhooks, output, POST, JSON, API, URL, manage webhooks, trigger, API Call URL, fields, headers, parameters