Skip to main content

Events and Payloads

You can create webhooks that subscribe to one or more events listed on this page. Each webhook event listed here includes a description of the properties and an example payload.

Common properties​

Each webhook, in addition to the event-specific properties, will include the following common properties:

link
eventstring
The name of the event that triggered the webhook.
link
dataobject
The event-specific data. See the corresponding section under event types for more information.

Common headers​

Each POST request will include the following headers:

link
user-agentstring
The HTTP client used to send the request. This will always be ConCat/AxiosHTTPClient.
link
authorizationstring
A bearer token with a signed JWT payload containing a base64-encoded sha256 hash of the data property. See Validating Payloads for more information.

Event types​

volunteer-submitted​

When a user creates a new volunteer application.

link
volunteerobject
The volunteer record containing the user's application.
Show child attributes
link
idstring
The unique identifier of the volunteer application.
link
contactMethodstring
The preferred method of contact for the volunteer.
link
contactMethodskey-value pair of strings
The contact methods for the volunteer.
Show child attributes
link
keystring
A string representing the type of contact method.
link
valuestring
An arbitrary string provided by the user for the contact method.
link
availableBeforeConboolean
Whether the volunteer is available before the event.
link
anythingElsestring (optional)
nullable
Any additional information the user provided.
link
previousConExperiencestring (optional)
nullable
The user's previous convention experience.
link
previousOtherExperiencestring (optional)
nullable
The user's previous experience outside of events that may relate to their preferred departments.
link
eventsCanNotMissstring (optional)
nullable
Any panels or events the user would not want to miss.
link
createdAtISO-8601 Date
The date the volunteer application was created.
link
updatedAtISO-8601 Date
The date the volunteer application was last updated.
link
userobject
The user who created the volunteer application.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
Responseapplication/json
{
  "event": "volunteer-submitted",
  "data": {
    "volunteer": {
      "id": "1234",
      "contactMethod": "email",
      "contactMethods": {
        "email": "johnny.test@concat.systems",
        "discord": "JohnnyTest#1234",
      },
      "availableBeforeCon": true,
      "anythingElse": "I'm a pretty cool guy.",
      "previousConExperience": "I've been to a few conventions.",
      "previousOtherExperience": "I've worked at a few conventions.",
      "eventsCanNotMiss": "I really want to see the panel on how to make a better sandwich.",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "user": {
      "id": "1234",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "preferredName": "Johnny",
      "lastName": "Test",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

volunteer-updated​

When an existing volunteer application is updated.

link
volunteerobject
The volunteer record containing the user's application.
Show child attributes
link
idstring
The unique identifier of the volunteer application.
link
contactMethodstring
The preferred method of contact for the volunteer.
link
contactMethodskey-value pair of strings
The contact methods for the volunteer.
Show child attributes
link
keystring
A string representing the type of contact method.
link
valuestring
An arbitrary string provided by the user for the contact method.
link
availableBeforeConboolean
Whether the volunteer is available before the event.
link
anythingElsestring (optional)
nullable
Any additional information the user provided.
link
previousConExperiencestring (optional)
nullable
The user's previous convention experience.
link
previousOtherExperiencestring (optional)
nullable
The user's previous experience outside of events that may relate to their preferred departments.
link
eventsCanNotMissstring (optional)
nullable
Any panels or events the user would not want to miss.
link
createdAtISO-8601 Date
The date the volunteer application was created.
link
updatedAtISO-8601 Date
The date the volunteer application was last updated.
link
userobject
The user who created the volunteer application.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
Responseapplication/json
{
  "event": "volunteer-updated",
  "data": {
    "volunteer": {
      "id": "1234",
      "contactMethod": "email",
      "contactMethods": {
        "email": "johnny.test@concat.systems",
        "discord": "JohnnyTest#1234",
      },
      "availableBeforeCon": true,
      "anythingElse": "I'm a pretty cool guy.",
      "previousConExperience": "I've been to a few conventions.",
      "previousOtherExperience": "I've worked at a few conventions.",
      "eventsCanNotMiss": "I really want to see the panel on how to make a better sandwich.",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "user": {
      "id": "1234",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "preferredName": "Johnny",
      "lastName": "Test",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

volunteer-assigned​

When a volunteer is assigned to a department.

link
volunteerobject
The volunteer record containing the user's application.
Show child attributes
link
idstring
The unique identifier of the volunteer application.
link
contactMethodstring
The preferred method of contact for the volunteer.
link
contactMethodskey-value pair of strings
The contact methods for the volunteer.
Show child attributes
link
keystring
A string representing the type of contact method.
link
valuestring
An arbitrary string provided by the user for the contact method.
link
availableBeforeConboolean
Whether the volunteer is available before the event.
link
anythingElsestring (optional)
nullable
Any additional information the user provided.
link
previousConExperiencestring (optional)
nullable
The user's previous convention experience.
link
previousOtherExperiencestring (optional)
nullable
The user's previous experience outside of events that may relate to their preferred departments.
link
eventsCanNotMissstring (optional)
nullable
Any panels or events the user would not want to miss.
link
createdAtISO-8601 Date
The date the volunteer application was created.
link
updatedAtISO-8601 Date
The date the volunteer application was last updated.
link
userobject
The user who created the volunteer application.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
link
departmentobject
The department the volunteer was assigned to.
Show child attributes
link
idstring
The unique identifier of the department.
link
namestring
The name of the department.
link
emailstring
The email address for contacting the department lead.
link
publiclyVisibleboolean
Whether the department is publicly visible.
link
createdAtISO-8601 Date
The date the department was created.
link
updatedAtISO-8601 Date
The date the department was last updated.
Responseapplication/json
{
  "event": "volunteer-assigned",
  "data": {
    "volunteer": {
      "id": "1234",
      "contactMethod": "email",
      "contactMethods": {
        "email": "johnny.test@concat.systems",
        "discord": "JohnnyTest#1234",
      },
      "availableBeforeCon": true,
      "anythingElse": "I'm a pretty cool guy.",
      "previousConExperience": "I've been to a few conventions.",
      "previousOtherExperience": "I've worked at a few conventions.",
      "eventsCanNotMiss": "I really want to see the panel on how to make a better sandwich.",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "user": {
      "id": "1234",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "preferredName": "Johnny",
      "lastName": "Test",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "department": {
      "id": "1234",
      "name": "Registration",
      "email": "registration@concat.event",
      "publiclyVisible": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

volunteer-unassigned​

When a volunteer is removed from a department.

link
volunteerobject
The volunteer record containing the user's application.
Show child attributes
link
idstring
The unique identifier of the volunteer application.
link
contactMethodstring
The preferred method of contact for the volunteer.
link
contactMethodskey-value pair of strings
The contact methods for the volunteer.
Show child attributes
link
keystring
A string representing the type of contact method.
link
valuestring
An arbitrary string provided by the user for the contact method.
link
availableBeforeConboolean
Whether the volunteer is available before the event.
link
anythingElsestring (optional)
nullable
Any additional information the user provided.
link
previousConExperiencestring (optional)
nullable
The user's previous convention experience.
link
previousOtherExperiencestring (optional)
nullable
The user's previous experience outside of events that may relate to their preferred departments.
link
eventsCanNotMissstring (optional)
nullable
Any panels or events the user would not want to miss.
link
createdAtISO-8601 Date
The date the volunteer application was created.
link
updatedAtISO-8601 Date
The date the volunteer application was last updated.
link
userobject
The user who created the volunteer application.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
link
departmentobject
The department the volunteer was removed from.
Show child attributes
link
idstring
The unique identifier of the department.
link
namestring
The name of the department.
link
emailstring
The email address for contacting the department lead.
link
publiclyVisibleboolean
Whether the department is publicly visible.
link
createdAtISO-8601 Date
The date the department was created.
link
updatedAtISO-8601 Date
The date the department was last updated.
Responseapplication/json
{
  "event": "volunteer-unassigned",
  "data": {
    "volunteer": {
      "id": "1234",
      "contactMethod": "email",
      "contactMethods": {
        "email": "johnny.test@concat.systems",
        "discord": "JohnnyTest#1234",
      },
      "availableBeforeCon": true,
      "anythingElse": "I'm a pretty cool guy.",
      "previousConExperience": "I've been to a few conventions.",
      "previousOtherExperience": "I've worked at a few conventions.",
      "eventsCanNotMiss": "I really want to see the panel on how to make a better sandwich.",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "user": {
      "id": "1234",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "preferredName": "Johnny",
      "lastName": "Test",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "department": {
      "id": "1234",
      "name": "Registration",
      "email": "registration@concat.event",
      "publiclyVisible": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    }
  }
}

volunteer-deleted​

When a volunteer has their volunteer application deleted.

link
volunteerobject
The volunteer record containing the user's application.
Show child attributes
link
idstring
The unique identifier of the volunteer application.
link
contactMethodstring
The preferred method of contact for the volunteer.
link
contactMethodskey-value pair of strings
The contact methods for the volunteer.
Show child attributes
link
keystring
A string representing the type of contact method.
link
valuestring
An arbitrary string provided by the user for the contact method.
link
availableBeforeConboolean
Whether the volunteer is available before the event.
link
anythingElsestring (optional)
nullable
Any additional information the user provided.
link
previousConExperiencestring (optional)
nullable
The user's previous convention experience.
link
previousOtherExperiencestring (optional)
nullable
The user's previous experience outside of events that may relate to their preferred departments.
link
eventsCanNotMissstring (optional)
nullable
Any panels or events the user would not want to miss.
link
createdAtISO-8601 Date
The date the volunteer application was created.
link
updatedAtISO-8601 Date
The date the volunteer application was last updated.
link
userobject
The user who created the volunteer application.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
link
departmentobject
The department the volunteer was assigned to.
Show child attributes
link
idstring
The unique identifier of the department.
link
namestring
The name of the department.
link
emailstring
The email address for contacting the department lead.
link
publiclyVisibleboolean
Whether the department is publicly visible.
link
createdAtISO-8601 Date
The date the department was created.
link
updatedAtISO-8601 Date
The date the department was last updated.
Responseapplication/json
{
  "event": "volunteer-deleted",
  "data": {
    "volunteer": {
      "id": "1234"
    }
  }
}

registration-updated​

The user created or updated their attendee registration.

link
registrationobject
The registration record containing the user's event registration.
Show child attributes
link
attendanceTypeIdstring
The unique identifier of the attendance type product.
link
badgeArtIdnumber
The unique identifier for the user's chosen badge art.
link
badgeNamestring
The user's chosen badge name.
link
idstring
The unique identifier of the registration.
link
userIdstring
The unique identifier of the user.
link
createdAtISO-8601 Date
The date the registration was created.
link
updatedAtISO-8601 Date
The date the registration was last updated.
link
userobject
The user who created the registration.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
Show child attributes
link
keystring
The name of the social account (e.g. "twitter" or "discord").
link
valuestring
The unique identifier of the social account (e.g. "1234" or "JohnnyTest#1234"), with the format depending on the third-party service.
Responseapplication/json
{
  "event": "registration-updated",
  "data": {
    "registration": {
      "attendanceTypeId": "91011",
      "badgeArtId": 12,
      "badgeName": "Test User",
      "id": "1234",
      "userId": "5678",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z"
    },
    "user": {
      "id": "5678",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "lastName": "Test",
      "preferredName": "Johnny",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "socialLinks": {
        "twitter": "1234",
        "discord": "JohnnyTest#1234"
      }
    }
  }
}

user-updated​

The user's profile was created or updated.

link
userobject
The user's profile.
Show child attributes
link
idstring
The unique identifier of the user.
link
usernamestring
The username of the user.
link
firstNamestring
The first name of the user.
link
preferredNamestring (optional)
nullable
The preferred name of the user. If provided, this should be used instead of the first and last name, except where legally required.
link
lastNamestring
The last name of the user.
link
emailstring
The email address of the user.
link
verifiedboolean
Whether the user's email address has been verified.
link
createdAtISO-8601 Date
The date the user was created.
link
updatedAtISO-8601 Date
The date the user was last updated.
link
organizationIdstring
A unique identifier for the organization the user account belongs to. This is used to share a single account across all events run by the same organization.
Responseapplication/json
{
  "event": "registration-updated",
  "data": {
    "user": {
      "id": "5678",
      "username": "JohnnyTest",
      "firstName": "Johnny",
      "lastName": "Test",
      "preferredName": "Johnny",
      "email": "johnny.test@concat.systems",
      "verified": true,
      "createdAt": "2020-01-01T00:00:00.000Z",
      "updatedAt": "2020-01-01T00:00:00.000Z",
      "organizationId": "e9eb88a2-6b61-4feb-bbd7-744a05f4ace6"
    }
  }
}