TixFinDocs

Integrations

Link your shop from your own website and give other systems controlled API access to your project

3 min read

Your TixFin shop is where buyers buy. To sell from your own website, link to the shop or to an event in it. To let another system, such as your ERP or a reporting tool, read project data, create a partner API key.

Where: account menu (avatar) → Account → Integrations Who can do this: members allowed to update the project (owners, admins, or a role with project update). You need two-factor authentication; without it the Integrations section is hidden. Creating, rotating and revoking a key and switching a group ask you to confirm your second factor again if you last did so more than ten minutes ago.

Partner API keys and endpoint groups
  1. Integrations
  2. Endpoint groups
  3. Create API key
  4. Rotate or revoke a key
📸 Partner API keys and endpoint groups

Click Copy next to Your shop: on the project overview (Project settings → Overview), or next to Event in the shop: on a published event's page, and put the link on your website. There are no ready-made plugins for Shopify, WordPress or other website builders today.

Create a partner API key

Select the project in the sidebar, then open the account menu → Account → Integrations.
Under Endpoint groups, switch on the groups the key may use. A group that is off is closed to every key.
Click Create API key, enter a Key name (up to 120 characters) and tick the Allowed endpoint groups.
Click Create key. Copy the key with Copy key and store it safely. It is only shown once.

Every key works for this project only and only for the groups it carries and the project has switched on. A project can have up to 50 active keys.

  • Rotate gives the key a new secret and keeps its name and groups. The old secret stops working at once. Hold Hold to rotate to confirm, then copy the new key. It is shown only once.
  • Revoke stops the key immediately: hold Hold to revoke to confirm. A revoked key cannot be rotated. Create a new one instead.

Every key change and group switch is listed under Audit trail, including revocations by TixFin support. For the API itself, see the API overview.

Send events to your server

To have another system told the moment an order is paid, tickets are issued or passed on, a ticket is checked in or an order is refunded, add a webhook endpoint under account menu → Account → Webhooks. Each request is signed, failed deliveries are retried for about two days, and every delivery is listed with its result. See Webhooks for the events, the payloads and how to verify the signature.

Common problems

  • "Select a project first to manage partner API access and API keys." Choose a project in the sidebar.
  • "You need project settings access to manage partner API integrations." Ask the project owner for the permission.
  • Integrations is missing from the account settings. Set up two-factor authentication under Security first.
  • An integration stopped working. Its key was revoked or rotated, or a group it uses was switched off. Give it the rotated key, create a new key, or switch the group back on.
  • "Could not load". That part of the page did not load. Click Try again.
  • "The project has 50 live keys". Revoke a key you no longer use, then create the new one.

On this page