HIhify
Import Runs

Upload a tournament import on a partner's behalf (Retool)

Admin only. Takes the same payload a partner feed sends — players and/or matches; a match draw is the matches-only form — and queues it through the same pipeline. The partner is resolved to its active schedule_ingest integration; the tournament is written to approval_mappings at creation, so the run skips the first-run staging a feed needs. The payload is validated before the run is created, so a bad one comes back in this response rather than as a failed run.

post/v1/admin/import_runs

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Request body

partner_idinteger required

Must have an active schedule_ingest integration.

tournament_idstring uuid required

The HiFy tournament to apply the payload to. Refused when another partner manages it.

Response

The queued run

idstring uuid
source'partner_api' | 'retool_upload'

partner_api: sent by the partner's signed feed. retool_upload: submitted by ops from Retool on the partner's behalf.

kindstring

Free-form; grows with each importer. e.g. tournament_import

status'open' | 'in_progress' | 'completed' | 'failed' | 'staged'
partner_integration_idinteger nullable
importable_typestring nullable
importable_idstring uuid nullable
row_countinteger nullable
processed_countinteger
approval_mappingsobject

Ids ops attached when approving, e.g. a tournament_id uuid.

summaryobject
pending_mappingsstring[]

Lifted out of summary. What a staged run is waiting for ops to attach.

error_detailsobject[]
initiated_by_idstring uuid nullable
started_atstring date-time nullable
finished_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

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