RoofKit
Developer docsPartner API
API keys

Track form submission

Records a form submission event and upserts a lead when email or phone is present.

Bearer API key · Scope: analytics.manage

Endpoint

POST/api/v1/events/form-submission
Request bodyrequired
application/json
FormSubmissionEventWrite
Headers1 parameter
  • Idempotency-Keyrequired
    string

    —

Responses

200Submission duplicate or idempotent replay returned.

Headers

  • Idempotency-ReplayedPresent and true when a stored successful write response was replayed.
application/json
FormSubmissionTrackResponse
201Form submission recorded.
application/json
FormSubmissionTrackResponse
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Headers