public-api

Create Webhook

Register a new webhook endpoint to receive event notifications.

Supported events: visibility_changed, report_completed, competitor_added, citation_gained, citation_lost.

post/webhooks

Request

  • Base URL: https://api.trakkr.ai
  • URL: https://api.trakkr.ai/webhooks
  • Auth: HTTP bearer

Request body

urlstring required

HTTPS endpoint URL

eventsstring[] required

Event types to subscribe to

brand_idstring uuid required

Brand UUID

auth_type'none' | 'bearer' | 'basic' | 'api_key' nullable

Authentication: "none", "bearer", "basic", or "api_key"

auth_tokenstring nullable

Bearer token (if auth_type is bearer)

auth_usernamestring nullable
auth_passwordstring nullable
api_key_headerstring nullable
api_key_valuestring nullable
signing_secretstring nullable

Custom signing secret (auto-generated if omitted)

headersobject nullable
payload_templateobject nullable

Response

Successful Response

idstring required
objectstring
urlstring required
eventsstring[] required
brand_idstring required
providerstring required
activeboolean required
signing_secretstring nullable
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.