Inbound Webhooks
Inbound webhooks let outside services send lead data into a KickoffLabs campaign. They are the opposite of outbound webhooks: your third-party service or backend sends the request to KickoffLabs.
Creating an inbound webhook
Section titled “Creating an inbound webhook”You can create an inbound webhook in the KickoffLabs dashboard or via the API.
POST https://api.kickofflabs.com/v2/CAMPAIGN_ID/inbound-webhook
Required parameters:
api_key: Your API key, or send it in anAuthorization/Authenticationheader for JSON requests.
Optional parameters:
name: Webhook name. Defaults toInbound via API.tag_id: If provided and found in the campaign, leads received by this inbound webhook are associated with that tag.source: Optional source tracking value stored with the webhook.
Successful response:
{ "message": "Inbound Webhook Created", "url": "https://..."}Use the returned url as the destination in the third-party system that will send leads to KickoffLabs.
Technical specifications
Section titled “Technical specifications”- Inbound webhook creation requires an authorized API key for the campaign.
- If
tag_idis provided but does not match a tag in the campaign, the webhook is still created without a tag. - The inbound webhook URL handles creating the lead and returns a KickoffLabs lead payload when the lead is accepted.
- When an inbound webhook creates a lead successfully, the response status is
201. - If the webhook has an associated tag, the created lead is tagged.
Lead fields
Section titled “Lead fields”The inbound webhook uses the same lead create behavior as the Leads API. At least one of these should be present in the incoming data:
emailphone_number
Any additional non-reserved fields can be captured as custom fields. See Create or Update a New Lead for validation and custom-field behavior.
Use cases
Section titled “Use cases”- Receive leads from forms hosted outside KickoffLabs.
- Connect third-party tools that can POST to a webhook URL.
- Apply a tag automatically to leads from a specific inbound source.
Troubleshooting
Section titled “Troubleshooting”- If creation fails with invalid API access, confirm the API key has access to the campaign.
- If lead creation fails validation, confirm the payload includes a valid
emailorphone_number. - If you expected tagging, confirm the
tag_idexists in that campaign before creating the inbound webhook.