Contents
Introduction
In order to receive registration event webhooks from BidJS you need to create an account with Svix and supply BidJS support with your Consumer App ID (which starts 'app_') and API Access Key, both of which are generated by Svix.
What data is included in the Registration Event Webhook?
Once set up you can subscribe to Registration events for auction and receive the following data per event:
{
"auctionUuid": "string",
"auctioneerUuid": "string",
"countryCode": "string",
"countryName": "string",
"email": "string",
"fullName": "string",
"paddleNumber": "string",
"registrationUuid": "string",
"spendingLimit": "string",
"statusName": "string",
"userUuid": "string",
"username": "string" }
How to Create your Consumer App
To create an account go to https://www.svix.com.
You will need to login and generate an API Access Key in order to successfully create your Consumer App.
To do this, navigate to API Access and click on Create key. Svix will ask you to name your key and click Create.
Important: The Svix API key is generated/displayed only once, so be sure to make a record of it so it can be supplied to BidJS Support and to successfully create your Consumer App.
Next, navigate to Consumer Applications and click on Add Application.
Svix will ask you to name your Consumer App and run a code snippet in your terminal, which includes your Svix API Key as per below.
Once this is successfully executed your Consumer App will appear within Consumer Applications.
curl -X POST "https://api.eu.svix.com/api/v1/app/" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer Your_Svix_API_Key" \ -d '{"name": "My App"}'
How to access your Consumer App ID
Within your Svix account, go to Consumer Applications.
Hover over the Consumer App ID and click to copy the ID (see image below)
How to Add an Endpoint
Some clients may wish to use a third-party tool (such as Zapier or Mailchimp) that supports Webhooks in order to create automation within their workflow.
If this is something you would like to do you will need to configure the third-party tool, as is required, and add the endpoint supplied into the Svix Consumer App for the specific BidJS webhook.
Go to Consumer Applications and click on your Consumer Application.
Within the Consumer App view click on Preview App Portal
Within the Portal click on Add Endpoint
Enter your desired endpoint and hit enter.
How to access your Endpoint ID
Within your Svix account, go to Consumer Applications and select the Consumer App you wish to apply your endpoint to.
Go to Preview App Portal.
Within Endpoints, click on the endpoint inputted previously.
Hover over your Endpoint ID fragment and click to copy (see image below).
