{"_id":"55fa0a1fd6f4370d001d99d2","version":{"_id":"54e431e6de9f5b2300fc6dbc","forked_from":"545a65231d018b1400227d92","project":"545a65231d018b1400227d8f","__v":10,"createdAt":"2015-02-18T06:32:06.531Z","releaseDate":"2015-02-18T06:32:06.531Z","categories":["54e431e7de9f5b2300fc6dbd","54e431e7de9f5b2300fc6dbe","54e56a85c2f66835000133c3","54ff948548c94d23004f1e17","5527280be69c7d0d00047eaf","55273bb14a7ac121004c60f0","55274588975eef3700ca8077","552748df9d4bcd2300d0383d","55274dd79d4bcd2300d0384a","55fa03180e1f1f1700a1f6ce","55fa3172d6f4370d001d99fd"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":2,"category":{"_id":"55fa03180e1f1f1700a1f6ce","__v":2,"pages":["55fa0a1fd6f4370d001d99d2","55fa118917b9d00d00969e5d"],"project":"545a65231d018b1400227d8f","version":"54e431e6de9f5b2300fc6dbc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-17T00:02:32.215Z","from_sync":false,"order":1,"slug":"data-structures","title":"Data structures"},"project":"545a65231d018b1400227d8f","user":"545a64cfbf1d2b0e00aaa091","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-17T00:32:31.687Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"An **event** is the core data object for Attendly. All the other data structures hang off the event in some way or another. \n\nIf you have any questions about how an event works or how the parameters affect the event, please contact us.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"ID\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"*int*\",\n    \"0-2\": \"The events ID\",\n    \"1-0\": \"Name\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"The events name. This is used as the main heading on the registration page.\",\n    \"2-0\": \"Description\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"The description of the event. This can be HTML\",\n    \"3-0\": \"PresentedBy\",\n    \"3-1\": \"*string*\",\n    \"3-2\": \"This should be yours or your companies name. Can also be blank.\",\n    \"4-0\": \"NotAvailableMessage\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"This is shown when the event is no longer available (ie. \\\"Sorry but this event is no longer available\\\")\",\n    \"5-0\": \"ThanksMessage\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"This is shown on the thanks page after an attendee registers. eg. \\\"Thanks for registering for our event\\\"\",\n    \"6-0\": \"EmailMessage\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"This is part of the confirmation email sent to attendees when they register for your event. eg. \\\"Thanks for registering, see you at the event\\\"\",\n    \"7-0\": \"FooterText\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"This is shown on the footer of the confirmation email.\",\n    \"8-0\": \"Notification\",\n    \"8-1\": \"*bool*\",\n    \"8-2\": \"If true, we will send you an email when someone registers for this event\",\n    \"9-0\": \"ShowDetails\",\n    \"9-1\": \"*bool*\",\n    \"9-2\": \"If true we will show the event details on the main event page (defaults to true).\",\n    \"10-0\": \"ShowComments\",\n    \"10-1\": \"*bool*\",\n    \"10-2\": \"If true we will allow people to add comments to the event.\",\n    \"11-0\": \"ShowDeadline\",\n    \"11-1\": \"*bool*\",\n    \"11-2\": \"If false we will hide the event deadline date.\",\n    \"12-0\": \"AttachTicket\",\n    \"12-1\": \"*bool*\",\n    \"12-2\": \"if true we will attach a PDF ticket to the confirmation email. The ticket will include a QR and bar code for identifying the attendee.\",\n    \"13-0\": \"Deadline\",\n    \"13-1\": \"*time*\",\n    \"13-2\": \"The deadline for accepting registrations.\",\n    \"14-0\": \"Start\",\n    \"14-1\": \"*time*\",\n    \"14-2\": \"The start time of the event\",\n    \"15-0\": \"Stop\",\n    \"15-1\": \"*time*\",\n    \"15-2\": \"The stop time of the event\",\n    \"16-0\": \"ActiveStart\",\n    \"16-1\": \"*time*\",\n    \"16-2\": \"This is when the event starts accepting registrations. Its default is yesterday (ie. it allows you to start selling tickets straight away.) You can use this to set an event up but not start selling tickets until a set time.\",\n    \"17-0\": \"PrettyDeadline\",\n    \"17-1\": \"*string*\",\n    \"17-2\": \"This is a pretty representation of the deadline, eg: \\\"Fri, 7 Apr 2015 5:00PM\\\"\",\n    \"18-0\": \"PrettyStart\",\n    \"18-1\": \"*string*\",\n    \"18-2\": \"This is a pretty representation of the start time, eg.  \\\"Fri, 7 Apr 2015 5:00PM\\\"\",\n    \"19-2\": \"This is a pretty representation of the stop time, eg.  \\\"Fri, 7 Apr 2015 5:00PM\\\"\",\n    \"19-0\": \"PrettyStop\",\n    \"19-1\": \"*string*\",\n    \"20-0\": \"Terms\",\n    \"20-1\": \"*string*\",\n    \"20-2\": \"Any extra terms and conditions (in addition to Attendlys) you would like added.\",\n    \"21-0\": \"PushURL\",\n    \"21-1\": \"*string*\",\n    \"21-2\": \"A URL we will send push notifications to (when an attendee registers)\",\n    \"22-0\": \"Subdomain\",\n    \"22-1\": \"*string*\",\n    \"22-2\": \"A subdomain for the event URL.\",\n    \"23-0\": \"ReturnURL\",\n    \"23-1\": \"*string*\",\n    \"23-2\": \"This is the URL we will redirect the attendee to after they register (after a few seconds). Its default is to leave them on the thanks page.\",\n    \"24-0\": \"Hashtag\",\n    \"24-1\": \"*string*\",\n    \"24-2\": \"If set we will show a twitter widget showing any tweets with the given hashtag\",\n    \"25-0\": \"Currency\",\n    \"25-1\": \"*string*\",\n    \"25-2\": \"USD, GBP, AUD etc.\",\n    \"26-0\": \"Password\",\n    \"26-1\": \"*string*\",\n    \"26-2\": \"This is used to make the event private\",\n    \"27-0\": \"TimezoneName\",\n    \"27-1\": \"*string*\",\n    \"27-2\": \"We use this to calculate the times. eg. \\\"Australia/Melbourne\\\", \\\"Europe/Berlin\\\"\",\n    \"28-0\": \"UserID\",\n    \"28-1\": \"*int*\",\n    \"28-2\": \"The users (probably yours) ID\",\n    \"29-0\": \"GroupID\",\n    \"29-1\": \"*int*\",\n    \"29-2\": \"The ID for the group that this event is in. Note that the group is the folder in the Attendly admin interface. You can use groups (folders) to  group events together.\",\n    \"30-0\": \"GroupName\",\n    \"30-1\": \"*string*\",\n    \"30-2\": \"The name of the group (folder) that this event is in.\",\n    \"31-0\": \"Status\",\n    \"31-1\": \"*string*\",\n    \"31-2\": \"The status of the event. Valid statuses are: \\\"active\\\", \\\"draft\\\", \\\"deleted\\\". In general you should always leave the status as active and use ActiveStart above to control access to your event.\",\n    \"32-0\": \"Available\",\n    \"32-1\": \"*bool*\",\n    \"32-2\": \"Available returns true if the event is active and we have not reached the event deadline. In other words, is the event available to buy tickets.\",\n    \"33-0\": \"TimeTillStart\",\n    \"33-1\": \"*string*\",\n    \"33-2\": \"This returns how long until the event starts in a \\\"human\\\" format, eg. \\\"1 day from now\\\"\",\n    \"34-0\": \"TimeTillDeadline\",\n    \"34-1\": \"*string*\",\n    \"34-2\": \"This returns how long until the event registration deadline in a \\\"human\\\" format, eg. \\\"3 hours from now\\\"\",\n    \"35-0\": \"EditDeadline\",\n    \"35-1\": \"*time*\",\n    \"35-2\": \"This is the deadline for attendees to be able to edit their information (in their profile). It defaults to the event deadline.\",\n    \"36-0\": \"EditUserDetails\",\n    \"36-1\": \"*bool*\",\n    \"36-2\": \"This determines if attendees are able to edit their details after registering.\",\n    \"37-0\": \"EventSlug\",\n    \"37-1\": \"*string*\",\n    \"37-2\": \"This is used as the \\\"nice\\\" version of the events address. For example instead of https://attendly.me/e/view/123 you can use a slug so that that it is: https://attendly.me/castlemaine-half-marathon\",\n    \"38-0\": \"URL\",\n    \"38-1\": \"*string*\",\n    \"38-2\": \"This is the URL to your event (with event slug etc.) for registering.\"\n  },\n  \"cols\": 3,\n  \"rows\": 39\n}\n[/block]","excerpt":"","slug":"event-data-structure","type":"basic","title":"Event data structure"}

Event data structure


An **event** is the core data object for Attendly. All the other data structures hang off the event in some way or another. If you have any questions about how an event works or how the parameters affect the event, please contact us. [block:parameters] { "data": { "0-0": "ID", "h-0": "Name", "h-1": "Type", "h-2": "Description", "0-1": "*int*", "0-2": "The events ID", "1-0": "Name", "1-1": "*string*", "1-2": "The events name. This is used as the main heading on the registration page.", "2-0": "Description", "2-1": "*string*", "2-2": "The description of the event. This can be HTML", "3-0": "PresentedBy", "3-1": "*string*", "3-2": "This should be yours or your companies name. Can also be blank.", "4-0": "NotAvailableMessage", "4-1": "*string*", "4-2": "This is shown when the event is no longer available (ie. \"Sorry but this event is no longer available\")", "5-0": "ThanksMessage", "5-1": "*string*", "5-2": "This is shown on the thanks page after an attendee registers. eg. \"Thanks for registering for our event\"", "6-0": "EmailMessage", "6-1": "*string*", "6-2": "This is part of the confirmation email sent to attendees when they register for your event. eg. \"Thanks for registering, see you at the event\"", "7-0": "FooterText", "7-1": "*string*", "7-2": "This is shown on the footer of the confirmation email.", "8-0": "Notification", "8-1": "*bool*", "8-2": "If true, we will send you an email when someone registers for this event", "9-0": "ShowDetails", "9-1": "*bool*", "9-2": "If true we will show the event details on the main event page (defaults to true).", "10-0": "ShowComments", "10-1": "*bool*", "10-2": "If true we will allow people to add comments to the event.", "11-0": "ShowDeadline", "11-1": "*bool*", "11-2": "If false we will hide the event deadline date.", "12-0": "AttachTicket", "12-1": "*bool*", "12-2": "if true we will attach a PDF ticket to the confirmation email. The ticket will include a QR and bar code for identifying the attendee.", "13-0": "Deadline", "13-1": "*time*", "13-2": "The deadline for accepting registrations.", "14-0": "Start", "14-1": "*time*", "14-2": "The start time of the event", "15-0": "Stop", "15-1": "*time*", "15-2": "The stop time of the event", "16-0": "ActiveStart", "16-1": "*time*", "16-2": "This is when the event starts accepting registrations. Its default is yesterday (ie. it allows you to start selling tickets straight away.) You can use this to set an event up but not start selling tickets until a set time.", "17-0": "PrettyDeadline", "17-1": "*string*", "17-2": "This is a pretty representation of the deadline, eg: \"Fri, 7 Apr 2015 5:00PM\"", "18-0": "PrettyStart", "18-1": "*string*", "18-2": "This is a pretty representation of the start time, eg. \"Fri, 7 Apr 2015 5:00PM\"", "19-2": "This is a pretty representation of the stop time, eg. \"Fri, 7 Apr 2015 5:00PM\"", "19-0": "PrettyStop", "19-1": "*string*", "20-0": "Terms", "20-1": "*string*", "20-2": "Any extra terms and conditions (in addition to Attendlys) you would like added.", "21-0": "PushURL", "21-1": "*string*", "21-2": "A URL we will send push notifications to (when an attendee registers)", "22-0": "Subdomain", "22-1": "*string*", "22-2": "A subdomain for the event URL.", "23-0": "ReturnURL", "23-1": "*string*", "23-2": "This is the URL we will redirect the attendee to after they register (after a few seconds). Its default is to leave them on the thanks page.", "24-0": "Hashtag", "24-1": "*string*", "24-2": "If set we will show a twitter widget showing any tweets with the given hashtag", "25-0": "Currency", "25-1": "*string*", "25-2": "USD, GBP, AUD etc.", "26-0": "Password", "26-1": "*string*", "26-2": "This is used to make the event private", "27-0": "TimezoneName", "27-1": "*string*", "27-2": "We use this to calculate the times. eg. \"Australia/Melbourne\", \"Europe/Berlin\"", "28-0": "UserID", "28-1": "*int*", "28-2": "The users (probably yours) ID", "29-0": "GroupID", "29-1": "*int*", "29-2": "The ID for the group that this event is in. Note that the group is the folder in the Attendly admin interface. You can use groups (folders) to group events together.", "30-0": "GroupName", "30-1": "*string*", "30-2": "The name of the group (folder) that this event is in.", "31-0": "Status", "31-1": "*string*", "31-2": "The status of the event. Valid statuses are: \"active\", \"draft\", \"deleted\". In general you should always leave the status as active and use ActiveStart above to control access to your event.", "32-0": "Available", "32-1": "*bool*", "32-2": "Available returns true if the event is active and we have not reached the event deadline. In other words, is the event available to buy tickets.", "33-0": "TimeTillStart", "33-1": "*string*", "33-2": "This returns how long until the event starts in a \"human\" format, eg. \"1 day from now\"", "34-0": "TimeTillDeadline", "34-1": "*string*", "34-2": "This returns how long until the event registration deadline in a \"human\" format, eg. \"3 hours from now\"", "35-0": "EditDeadline", "35-1": "*time*", "35-2": "This is the deadline for attendees to be able to edit their information (in their profile). It defaults to the event deadline.", "36-0": "EditUserDetails", "36-1": "*bool*", "36-2": "This determines if attendees are able to edit their details after registering.", "37-0": "EventSlug", "37-1": "*string*", "37-2": "This is used as the \"nice\" version of the events address. For example instead of https://attendly.me/e/view/123 you can use a slug so that that it is: https://attendly.me/castlemaine-half-marathon", "38-0": "URL", "38-1": "*string*", "38-2": "This is the URL to your event (with event slug etc.) for registering." }, "cols": 3, "rows": 39 } [/block]