API keys and webhooks

An owner or admin manages API keys and webhooks in "Settings" → "Integrations".

API key

1. Open "API keys" and click "Create key". Fill in "Name" and "Permissions" ("Read", "Write").
2. Copy the key (it starts with tklfy_) now; it is shown only once. Confirm with "I saved it".
3. Send it in the Authorization: Bearer or x-api-key header to https://api.tiklify.com/v1/api/. Limit: 60 requests per minute.

Revoke a lost key ("Revoke") and create a new one.

Webhook

1. Open "Webhooks" and click "Create webhook".
2. Keep version 2 (for current campaigns) in "Event version"; it sends campaign_target.status_changed and campaign.terminal.
3. Enter the "Endpoint URL (HTTPS)" (a public address, no IP address or credentials) and choose "Events".
4. Copy the "Signing secret"; it is shown only once.
5. Send a "Test"; the result is in "Recent deliveries".

Signature. The Tiklify-Signature header has the form t=…,v1=…. v1 is the HMAC-SHA256 (hex) of the timestamp t, a dot and the request body, keyed with your signing secret. Tiklify-Event and Tiklify-Event-Id describe the event.

Delivery. Your endpoint must answer with a 2xx code within 10 seconds; we do not follow redirects. Each delivery gets up to 5 attempts, with growing intervals from 30 seconds. After 5 failed deliveries in a row we switch the webhook off and send you a notice.

Still stuck? Write to us at hello@tiklify.com.