Create Attendance Records API | EventBookings Developer Hub

Create Attendance: /tickets/{ticket_uuid}/attendance

Purpose

This endpoint logs attendance activity for a specific ticket. It records data such as the device used, the activity type, session details, and the activity time, enabling tracking of ticket usage in events or sessions.

Scope

event.add_attendance → Attendances create permission must be granted from the application to create attendance for the ticket.

Use Case

Event organisers use this endpoint to track attendees' check-ins and check-outs for sessions or events. This is helpful for managing entry, preventing unauthorised access, and analyzing attendance data.

Path Parameters

Parameter	Type	Description
ticket_uuid	string	The unique identifier of the ticket being logged.

Query Parameters

This endpoint does not have any query parameters.

Request Body

The request body specifies attendance details, including the creator's ID, device information, activity type, session details, and activity timestamp.

              JSON
            

                  [
    {
        "created_by": "CREATED_BY",
        "device": {
            "uuid": "DEVICE_UUID",
            "name": "DEVICE_NAME"
        },
        "activity_on": {
            "utc": "YYYY-MM-DDTHH:MM:SSZ"
        },
        "session": {
            "uuid": "SESSION_UUID",
            "name": "SESSION_NAME"
        },
        "type": "ACTIVITY_TYPE",
        "activity": "ACTIVITY_NAME"
    }
]

                

Key	Type	Description
uuid	String (UUID)	Unique identifier for the attendance record. Automatically set by the server.
created_by	String (UUID)	Unique identifier of the user or entity that created the attendance record.
device	Object	Details about the device used for the attendance activity.
device.uuid	String (UUID)	Unique identifier for the device.
device.name	String	Name of the device, e.g., "Scanner app."
activity_on	Object	Contains the timestamps of the activity in UTC and local formats.
activity_on.utc	String (Datetime)	UTC timestamp of the activity.
activity_on.local	String (Datetime)	Local timestamp of the activity.
session	Object/Array/Null	Information about the session. Can be an object, null, or an empty array when there is no session.
session.uuid	String (UUID)	Unique identifier for the session.
session.name	String	Name of the session.
type	String/Null	Represents the type of attendance. Null indicates it is the main attendance.
activity	String	Represents the activity type. For main attendance (when type is null), possible values are "check-in" and "check-out."

              JSON
            

                  {
    "statusCode": 200,
    "result": {
        "uuid": "UUID",
        "attributes": [
            {
                "name": "NAME",
                "value": "TICKET_NAME"
            },
            {
                "name": "ORDER_ID",
                "value": "ORDER"
            },
            {
                "name": "TICKET_ID",
                "value": "TICKET"
            },
            {
                "name": "SEAT",
                "value": SEAT
            },
            {
                "name": "CODES",
                "value": {
                    "type": "CODE_TYPE",
                    "value": "CODE_VALUE",
                    "image": "IMAGE"
                }
            }
        ],
        "product": [
            {
                "uuid": "PRODUCT_UUID",
                "name": "PRODUCT_NAME",
                "value": "PRODUCT_VALUE"
            },
            {
                "name": "DISABLE_SCANNING",
                "value": BOOLEAN,
                "message": "MESSAGE"
            },
            {
                "name": "EVENT_TIMEZONE",
                "value": "TIMEZONE"
            },
            {
                "name": "EVENT_STARTS_ON",
                "value": {
                    "utc": "YYYY-MM-DDTHH:MM:SSZ",
                    "local": "YYYY-MM-DDTHH:MM:SSZ"
                }
            },
            {
                "name": "SELL_SESSION",
                "value": BOOLEAN
            },
            {
                "name": "SESSION",
                "value": []
            },
            {
                "name": "ATTENDEE_DETAILS",
                "value": {
                    "uuid": "ATTENDEE_UUID",
                    "attributes": [
                        {
                            "field_name": "FIRST_NAME",
                            "field_value": "FIRST_NAME"
                        },
                        {
                            "field_name": "LAST_NAME",
                            "field_value": "LAST_NAME"
                        },
                        {
                            "field_name": "EMAIL",
                            "field_value": "EMAIL"
                        },
                        {
                            "field_name": "IMAGE",
                            "field_value": IMAGE
                        }
                    ]
                }
            },
            {
                "name": "ATTENDANCE_SETTINGS",
                "value": SETTINGS
            }
        ],
        "attendance": [
            {
                "uuid": "ATTENDANCE_UUID",
                "created_by": "CREATED_BY",
                "device": {
                    "uuid": "DEVICE_UUID",
                    "name": "DEVICE_NAME"
                },
                "activity_on": {
                    "utc": "YYYY-MM-DDTHH:MM:SSZ",
                    "local": "YYYY-MM-DDTHH:MM:SSZ"
                },
                "session": SESSION,
                "type": "ACTIVITY_TYPE",
                "activity": "ACTIVITY_NAME"
            }
        ]
    }
}

                

Attribute	Type	Description
statusCode	Integer	Represents the HTTP status code of the API response. A value of 200 indicates the request was successful.
result	Object	Contains detailed information about the event and associated entities.
result.uuid	String (UUID)	Unique identifier for the event or entity.
result.attributes	Array of Objects	List of attributes related to the event, such as name, order ID, ticket ID, and seat information.
attributes.name	String	Name of the attribute, e.g., "name," "order_id," "ticket_id," "seat," or "codes."
attributes.value	String/Object/Null	Value of the attribute. Can be a string, null, or an object depending on the attribute name.
attributes.value.type	String	Type of code.
attributes.value.value	String	Code value.
attributes.value.image	String	URL or path to the image representing the code.
result.product	Array of Objects	Details about the products or events related to the response.
result.product.uuid	String (UUID)	Unique identifier for the product or event.
product.name	String	Name of the product attribute.
product.value	String/Boolean/Array/Object	Value of the product attribute. Can be a string, boolean, array, or object depending on the attribute.
product.value.utc	String (Datetime)	UTC date and time when the event starts.
product.value.local	String (Datetime)	Local date and time when the event starts.
product.value.attributes	Array of Objects	List of attendee details attributes such as first name.
product.value.attributes.field_name	String	Name of the attendee detail field.
product.value.attributes.field_value	String	Value of the attendee detail field.
result.attendance	Array of Objects	Details about attendance, including UUID, device information, activity, and session.
attendance.uuid	String (UUID)	Unique identifier for the attendance record.
attendance.created_by	String (UUID)	UUID of the user or entity that created the attendance record.
attendance.device	Object	Information about the device used for attendance activities.
attendance.device.uuid	String	Unique identifier for the device.
attendance.device.name	String	Name of the device.
attendance.activity_on	Object	Details of the activity timestamp in both UTC and local formats.
attendance.activity_on.utc	String (Datetime)	UTC timestamp of the activity.
attendance.activity_on.local	String (Datetime)	Local timestamp of the activity.
attendance.session	Null/Object	Represents the session related to the attendance. Null when there is no session.
attendance.type	String	Type of activity or event.
attendance.activity	String	Activity performed, e.g., "check-in."