Establishes or updates the mapping between a Pixop team and a Mimir tenant, including:
- Creating or updating the Pixop webhook used to be notified of job status changes.
- Updating Mimir’s configuration according to the optional
mimirSetup
payload.
The mapping is established or updated using the provided headers (x-mimir-api-key
, x-mimir-tenant
, x-pixop-api-key
) and remains
active for the period specified by daysToLive
(default: 30 days). Thus the provided API keys need to be valid for at least this period.
Expiry behavior
- When the TTL elapses, the integration expires and is deleted (same effect as a
DELETE
on this resource). - Expiry removes webhooks and related state as documented under
DELETE /v1/admin/pixop-mimir-integration
.
Keeping the integration alive
- Call this endpoint periodically (e.g., weekly) before the TTL ends to extend the expiry.
If mimirSetup
is included, Mimir will be set up accordingly.
This includes creating custom actions for the provided Pixop processing configurations, as well as setting up
other settings such as whether processing jobs need to be approved, whether to extract thumbnails, full frames,
and a web video when a video is ingested in Pixop, and templates for the tooltip and label to be shown in the Mimir UI
for custom actions.
Please also note that manual steps in Mimir might be required to complete the setup, which will be returned in the response.
If mimirSetup
is not included, only the mapping between Pixop and Mimir, and the Pixop webhook will be created or updated. No changes will be made to Mimir setup.
Note: If the mimirSetup
contains processing configurations that do not exist in Pixop,
the request will fail with a 400
Bad Request and an error message indicating which configuration IDs are invalid.
Note: If Mimir setup fails for any reason (e.g. invalid API key, network issues, etc.), the entire request will fail and no changes will be made to the mapping or webhook.
Note: If an integration already exists for the given tenant with a different team ID, a 409
Conflict is returned.