curl --request POST \
--url https://attend.hackclub.com/api/v1/events/{event_id}/incidents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"incident": {
"category": "behavior",
"severity": "s2",
"summary": "Shoving in the queue",
"details": "Two attendees shoved each other.",
"visible_to_roles": [
"event_admin"
]
}
}
'{
"incident": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "safeguarding",
"severity": "s0",
"status": "open",
"summary": "Shoving in the queue",
"location": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"reported_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
},
"participant_names": [
"<string>"
],
"hq_report": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "open",
"created_at": "2023-11-07T05:31:56Z"
},
"details": "<string>",
"actions_taken": "<string>",
"visible_to_roles": [
"event_admin"
],
"medication_dispensed": true,
"medications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dose": "<string>",
"notes": "<string>"
}
],
"participants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Jane Doe",
"email": "[email protected]"
}
],
"helping_staff": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
],
"timeline": [
{
"type": "comment",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"body": "<string>",
"new_status": "open",
"author_name": "<string>",
"source": "<string>",
"slack_url": "<string>",
"action": "created",
"actor_name": "<string>",
"fields": [
"<string>"
]
}
],
"permissions": {
"update": true,
"comment": true,
"change_status": true,
"view_casework": true,
"escalate": true
}
},
"notice": "Incident logged and escalated to Hack Club HQ."
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Category can't be blank",
"errors": [
"Category can't be blank"
]
}Log an incident
Logs an incident reported by the caller. Anyone with a role on the event can log one.
Send escalate: true with an escalation object to also file a
confidential report to Hack Club HQ in the same call. Both halves are
validated before anything is saved, so a failed escalation (a missing
callback number, say) leaves no log entry behind; its errors come back
prefixed Escalation:. Behavior, safeguarding and other incidents that
are escalated are also posted to the Fire Dept Slack channel; medical
incidents stay HQ-only.
A medical incident must name at least one participant and one helping
staff member, and list the medication when medication_dispensed is
true.
curl --request POST \
--url https://attend.hackclub.com/api/v1/events/{event_id}/incidents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"incident": {
"category": "behavior",
"severity": "s2",
"summary": "Shoving in the queue",
"details": "Two attendees shoved each other.",
"visible_to_roles": [
"event_admin"
]
}
}
'{
"incident": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"category": "safeguarding",
"severity": "s0",
"status": "open",
"summary": "Shoving in the queue",
"location": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"reported_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
},
"participant_names": [
"<string>"
],
"hq_report": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "open",
"created_at": "2023-11-07T05:31:56Z"
},
"details": "<string>",
"actions_taken": "<string>",
"visible_to_roles": [
"event_admin"
],
"medication_dispensed": true,
"medications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dose": "<string>",
"notes": "<string>"
}
],
"participants": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Jane Doe",
"email": "[email protected]"
}
],
"helping_staff": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "[email protected]"
}
],
"timeline": [
{
"type": "comment",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"body": "<string>",
"new_status": "open",
"author_name": "<string>",
"source": "<string>",
"slack_url": "<string>",
"action": "created",
"actor_name": "<string>",
"fields": [
"<string>"
]
}
],
"permissions": {
"update": true,
"comment": true,
"change_status": true,
"view_casework": true,
"escalate": true
}
},
"notice": "Incident logged and escalated to Hack Club HQ."
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Category can't be blank",
"errors": [
"Category can't be blank"
]
}Authorizations
Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches.
Path Parameters
Event id or slug.
Body
Every incident field the API can write. On create, category and severity are required; on update send only what changes.
Show child attributes
Show child attributes
Also escalate to Hack Club HQ.
What the HQ report needs beyond the incident itself.
Show child attributes
Show child attributes
Response
Incident logged (and escalated, if asked).
The full incident. For a reporter who holds none of the roles it is shared with, actions_taken is null and timeline is empty.
Show child attributes
Show child attributes
Says whether the escalation went through. An incident can be logged while the HQ report fails to file; retry with POST /events/{event_id}/incidents/{id}/escalate.
"Incident logged and escalated to Hack Club HQ."
Was this page helpful?