Idempotency

Every endpoint accepts an optional Idempotency-Key header. Use it to safely retry requests when your network or our backend has a hiccup.

How it works

Your first request runs normally. We store the response body keyed on (apiKeyId, idempotencyKey).
Any request with the same key within 24h returns the same response with a header:
```
X-Idempotent-Replay: true
```
Two days later the cached row is purged. Calling with the same key again will re-execute the request.

Guidelines

The key is string ≤ 128 characters.
Generate one per business action: order_<order_id>, signup_<user_id>_<timestamp>, etc.
Don’t reuse keys across different operations. Each key represents one logical “attempt”.
The Idempotency-Key is scoped per API key — two different keys may use the same string without conflict.

Example

Fire a Purchase event with retry safety:


curl -X POST https://adtarget.io/api/v1/events/conversion \
  -H "Authorization: Bearer atk_live_..." \
  -H "Idempotency-Key: order_98765" \
  -H "Content-Type: application/json" \
  -d '{ "telegramUserId": 1234567890, "channelId": "-1001234567890", "eventType": "Purchase", "value": 49.00, "currency": "USD" }'

If your network drops the response and you retry with the same Idempotency-Key, AdTarget returns the original conversionId without firing a second Meta event.

We don’t validate that the body matches the original request. If you reuse a key with a different body, you’ll get back the original response — not the new one. Always generate a fresh key for a different intent.

What gets cached

The full response body and HTTP status code.
The conversionId for forensic linking.

We do not cache anything about the request body itself. The key is the sole replay identifier.

Combined with Meta dedup

Meta CAPI already deduplicates within 48h based on event_id. AdTarget uses a deterministic event_id per conversion send, so even without Idempotency-Key, a retry that creates a new conversion would still get deduplicated downstream by Meta. The Idempotency-Key adds an extra layer at our side — preventing a duplicate conversions row entirely.