Receiving Webhooks

In order to receive data from a webhook event, you must have a web server setup and configured to handle incoming requests. While you're free to use whatever programming language and web server framework you choose, we recommend using NodeJS with ExpressJS as a lightweight, easy to deploy option.

This webserver should be reachable via either a static IP address, or via a domain address.

Events

Our Webhook event list is growing all the time, currently the following events are supported: application.submitted -> Fired when a new application has been submitted

application.updated -> Fired when an application's status has been updated

profile.created -> Fired when a new community profile is registered. This is the same as a new user signing up for your community

profile.updated -> Fired when a profile's alias has been updated

profile.deleted -> Fired when a profile has been deleted

Webhook Events

application.submitted

Fired when a new application has been submitted

application.updated

Fired when an application's status has been updated

profile.created

Fired when a new community profile is registered. This is the same as a new user signing up for your community

profile.updated

Fired when a profile has been updated, in regards to awards, qualifications, units etc.

profile.deleted

Fired when a profile has been deleted

Data

We will not be specifying in documentation the layout or structure of the data being sent, however we recommend taking a robust approach to checking object properties before trying to access them.

Applications of Webhooks

The use of webhooks can be used for a number of automated actions within your community. Potential uses include discord notifications when a new application has been submitted, or when a user signs up on your Pro Panel.

As well as this, you could use the profile events to keep an external log of the profile, either via Discord or some other logging medium.

Was this page helpful?