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
mimirSetuppayload.
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: 90 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
DELETEon 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., monthly) before the TTL ends to extend the expiry.
- The TTL is automatically reset whenever new Pixop jobs are initiated.
If mimirSetup is included, Mimir will be configured accordingly.
This process creates custom actions for ingesting and deleting videos in Pixop, as well as for the specified Pixop processing configurations.
Additional settings are also applied, such as requiring approval for processing jobs, extracting thumbnails, full frames, and a web video during Pixop ingestion, and customizing labels and tooltips for Mimir UI actions and option lists.
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.
This integration is connected to Fonn, enabling seamless interaction between Pixop and the Fonn-powered Mimir platform.
