POST - createEvent

Create a new event. The endpoint allows you to create an event by providing all necessary event details.

Http method

POST

URL endpoint

https://api.ticbolt.com/v1/createEvent

Request header

API token - API token - The token can be easily copied from the partner dashboard for the project created.

Request body

Json object with the details of the event to be created.

Example structure :

{
  "externalEventId": "event123",
  "name": "Event Name",
  "eventSummary": "Some text here",
  "eventBannerImage": "https://somelinktotheimage.jpg",
  "nftLiveEventImage": "https://somelinktotheimage.jpg",
  "nftCollectibleImage": "https://somelinktotheimage.jpg",
  "organizerName": "John Doe",
  "organizerEmail": "[email protected]",
  "eventCategory": "category name",
  "eventTags": ["tag1","tag2"],
  "eventType": "Event type(Inperson/Online)",
  "details": {
    "online": {
      "meetingUrl": "Meeting url",
      "meetingId": "Meeting Id",
      "passcode": "Passcode"
    },
    "offline": {
      "location": "Location Name",
      "address1": "Address1",
      "address2": "Address2",
      "city": "city",
      "state": "State",
      "country": "Country"
    }
  },
  "ticketTypes":[
    {
      "section": "section name",
      "tickeTypeName": "ticket type",
      "availableSpaces": 100,
      "seated": true,
      "saleStartTime": "1613549200",
      "saleEndTime": "1613559200",
      "price": 100,
      "secondaryMarketPriceCap": 200
    }
  ],
  "primaryShareHolders": ["[email protected]", "[email protected]"],
  "primaryShares": [5000, 5000],
  "secondaryShareHolders": ["[email protected]", "[email protected]"],
  "secondaryShares": [3000, 7000],
  "royalties": 10,
  "eventTimezone": "Event Timezone",
  "recurrenceFrequency": "Event recurrence frequency",
  "numberOfDays": "Number of days",
  "numberOfWeeks": "Number of weeks",
  "weekDays": "Event week days",
  "eventStartTime": "1613559200",
  "eventEndTime": "1613559200",
  "eventValidators": ["[email protected], [email protected]"]
}

Parameter details

Parameter	Description
externalEventId	String - The ID of the event conducted by the organiser. This should be a unique Id in the client platform.
name	String - The name of the event to be passed on to the blockchain to register the event. This will be also used in NFT metadata.
eventSummary	String - The summary or description of the event. This will be used at the Ticstop market place.
eventBannerImage	String - The absolute URL of the banner image for the event. The image will be used at the Ticstop market place collection. The image must 1920px width and 1000px height. The type of image can be Jpg, png, or gif.
nftLiveEventImage	String - The absolute URL for an image to use it for the NFT during when event is not yet been started or finished. The image will be used at the Ticstop market place. The image must 1000px width and 100px height. The type of image can be Jpg, png, or gif.
nftCollectibleImage	String - The absolute URL for an image to use it for the NFT when the event is finished or used for entry to the event. The image will be used at the Ticstop market place. The image must 1000px width and 100px height. The type of image can be jpg, png, or gif.
organizerName	String - The name of the organizer conducting the event.
organizerEmail	String - The email of the organizer conducting the event. Since the email is unique, it will be used as an unique identifier in for the organizer in the platform.
eventCategory	String - The category name of the event.
eventTags	Array of Strings - The list of tags to be attached with the event.
eventType	String - This field will have either of the two values, that is, "Inperson" or "Online". Inperson should be used for physical event and Online should be used for virtual events.
details	Array of objects - The array will have two objects. Based on the eventType, one can pass either "online" or "offline" object.
online	object - The object has three parameters, meetingUrl, meetingId and passcode. All the parameters in the object have the type String.
offline	object - The object has six parameters, ie. location, address1 address2, city, state and country. All the parameters in the object have the type String.
ticketTypes	Array of objects - Each object in the array will have Information about different ticket types for the event.. section (String): Name or section associated with the ticket type. ticketTypeName (String): Name or type of the ticket. availableSpaces (Integer): Number of available ticket spaces. seated (Boolean): Indicates if the ticket type is for a seated event. saleStartTime (String): Start time for ticket sales (Epoch timestamp). saleEndTime (String): End time for ticket sales (Epoch timestamp). price (Integer): Price of the ticket. secondaryMarketPriceCap (Integer): Maximum price on the secondary market for the ticket.
primaryShareHolders	Array of Strings - Email addresses of primary shareholders for the event.
primaryShares	Array of Integers - Percentage of primary shares associated with each shareholder.
secondaryShareHolders	Array of Strings- Email addresses of secondary shareholders for the event.
secondaryShares	Array of Integers - Percentage of secondary shares associated with each shareholder.
royalties	Integer - Royalty percentage for event participants.
eventTimezone	String - Timezone of the event
recurrenceFrequency	String - Frequency of event recurrence (e.g., daily, weekly).
numberOfDays	Integer - Number of days for event recurrence
numberOfWeeks	Integer - Number of days for event recurrence
weekDays	Array of String - Days of the week when the event occurs.
eventStartTime	String - Start time for the event (Epoch timestamp).
eventEndTime	String - End time for the event (Epoch timestamp).
eventValidators	Array of String - The array will have email Ids as string.

The eventCreate API is an asynchronous request, means the success of event creation at block chain will not be known in the same request. The request will only respond with a transaction hash if the request successfully made to the block chain. On a successful creation of event at the block chain, the contractAddress of the event will be returned in a webhook createEventStatus.

Response:

Returns a JSON object containing the status of the request and the transaction hash and event Id of the event.

Response Attributes:

• status: A string indicating the status of the request, which could be "success" or "fail".

• data: A JSON object containing the response data:

  • transactionHash: The transaction hash of the event creation request to the block chain. This is only included in the response when the request status is "success".

  • message: A string describing the error that occurred. This attribute is only included in the response when the status is "fail".

Example Success Response:

{
  "status": "success",
  "data": {
    "transactionHash": "0x1234abcdef..."
  }
}

Example Fail Response:

{
  "status": "fail",
  "data": {
    "message": "Invalid User"
  }
}

Example Error Response:

{
  "status": "error",
  "message": "Internal server error"
}