Skip to main content

Guide: API Integrations

Follow the steps below to help an Agent integrate with our API

Updated today

1. Contact us with details

If a third-party agent would like to integrate with us, please contact us with:

a) Agent Name

b) What they would like to use our API for

c) Email Address of the main contact - so we can add them to our Slack community

This is not only for security purposes but also because they may have integrated with us already, in which case we can point them towards the correct channels

2. Create a Channel

a) Once integrated, then create a Channel for them

b) Let us know the Channel ID

c) You can find this at the end of the URL of their Channel page:

Screenshot 2024-06-10 at 17.42.16.png

d) We will then create an API Key for this Channel and will send it to you when built

3. Is the agent charging commission on sales?

a) If yes, create an Inside Adjuster and add their Channel to it

b) You'll then need to do add this to your Event's Price Table

Learn more - Adjusters

4. Add to Payment Method

a) Either create a new Custom Payment Method for Agent sales/invoices

b) Add the new Agent channel to it

c) Or add the Channel to an existing Payment Method

Learn more - Payment Methods

5. Add to Delivery Method

a) Either create a new Custom Delivery Method for Agent sales/invoices

b) Add the new Agent channel to it

c) Or add the Channel to an existing Delivery Method

Learn more - Delivery Methods

6. Channel Access

a) Add their Channel to the correct Performances and Prices on the Event pages

b) Add the channel to the Event Info page

7. API Key

a) Once this is ready, send it to the agent

b) You also need to send API URL, Delivery Method and Payment Method ID

Learn more - API Tokens

8. Any issues with their API access?

a) Please ask them to contact us on the Slack community

b) Our dev team will then be able to provide assistance

Did this answer your question?