To create a webhook:
- Go to Settings > Installation > Webhook Leads
- Click green button “Create API Key”
- Name it, describe the use for it, and set an expiration if you don’t want it to work forever… otherwise leave the date as it is.
- Save changes
- Copy the API Token in the blue field and save it – You will never be able to access it again.
To send a webhook:
- Build out a webform that you want to send leads to ResponsiBid.
- Add the functionality for it to post the form to a webhook. (Depending on how you build the form this functionality will differ from form builder to form builder)
- Send the webhook to: https://bids.responsibid.com/api/WebhookLeads/create.json?api=YourAPITokenHere (if you are on the beta server, be sure to replace the word “bids” to “beta)
- SPECIAL NOTE about STATUSES. If you want to populate a status in the ResponsiBid customer profile, the status field must match EXACTLY (even case sensitive) to what the ResponsiBid API can accept for your statuses. This can be very beneficial (especially as a hidden field) so that you can kick off follow-up automation, but to get that status name exactly right you will want to verify your options by going to this link: https://bids.responsibid.com/api/WebhookLeads/statuses.json?api=YourAPITokenHere — Once you go there, you will be given the exact list of statuses that you can send to the status field to achieve your statues. Any status name other than as they appear on this page will result in the customer being in “no status”
To map the fields of a webhook:
- Submit a test form to the webhook
- Go back to “Settings > Installation > Webhook Leads”
- Click on the globe icon next in the actions area of the key you just made
- If your test submitted properly you will see your first item in the “log” of your webhook you received
- Look in the “rawRequest” area of the log. Now you can see all the names of each field that your form sent over. Note the exact name of the field names you want to map.
- Click back on “Webhook Leads”
- Click on the edit pencil button of the webhook you want to map.
- Click on the “+” icon of the “Map Fields” section at the bottom of the window
- Match the fields names from the “rawRequest” area to the corresponding ResponsiBid fields you want to match.