Create Webhook
Register a URL that receives events (subscribe).
url: https only, no credentials in the URL, a public host. A URL change is a new endpoint.events: one or more of company.identified, company.returned, company.intensive_visit, segment.entered.websites: websites of your account; all of them when omitted.segment_id: required for segment.entered; the segment's website must be among the websites.headers: up to 3 custom request headers, never returned.
The answer carries secret once: keep it to verify the Webmetic-Signature header.
Up to 50 endpoints per account via the API (10 via the dashboard).
APIKeyHeaderAuthorization<token>application/json- body
Register a URL. The response carries the signing secret once.
url*Urlhttps URL that receives the events (POST)
events*array<string>Event types to receive: company.identified, company.returned, company.intensive_visit, segment.entered
1 <= itemswebsites?array<string>|Websites of your account to receive events for; all of them when omitted
description?DescriptionShown in the dashboard, for example 'Clay table Leads'
length <= 200""segment_id?|Segment id for segment.entered (the segment's website must be among the websites)
headers?array<>Up to 3 custom request headers
items <= 3source?SourceWhich tool receives the events: clay, n8n, make, zapier, custom
"custom"created_via?Created ViaInternal: 'dashboard' or 'api' (limits differ)
"api"The endpoint with its signing secret
application/json- response
The endpoint with its signing secret. The secret is shown here only.
id*Idurl*Urldescription?Description""events*array<string>websites*array<string>segment_id?string|nullsegment_label?string|nullheader_names?array<string>source?Source"custom"status*Statuscreated_via?Created Via"api"created_at*Created Atdate-timeupdated_at*Updated Atdate-timelast_success_at?|nulllast_failure_at?|nullfailing_since?|nulldisabled_at?|nulldisabled_reason?string|nullsecret_rotated_at?|nullsecret*SecretHMAC secret for the Webmetic-Signature header; shown once
curl -X POST 'https://hub.webmetic.de/webhooks' \ -H 'Content-Type: application/json' \ -d '{ "url": "https://website.example/webhook", "events": [ "company.identified" ]}'{ "id": "string", "url": "string", "description": "", "events": [ "string" ], "websites": [ "string" ], "segment_id": "string", "segment_label": "string", "header_names": [ "string" ], "source": "custom", "status": "string", "created_via": "api", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "last_success_at": "2019-08-24T14:15:22Z", "last_failure_at": "2019-08-24T14:15:22Z", "failing_since": "2019-08-24T14:15:22Z", "disabled_at": "2019-08-24T14:15:22Z", "disabled_reason": "string", "secret_rotated_at": "2019-08-24T14:15:22Z", "secret": "string"}