Alert Invites

The explanation for the configuration of the alert invitations that is available in InviteManager.

Alert invitations can be announced through the InviteManager's logging system.

Alert invites allow to create a alert for a specific amount of invites.

CommandDescription

/alert-invites add <amount>

Set up a new trigger for alert invite.

/alert-invites remove <amount>

Remove a existent alert invite in your server.

/alert-invites list

List all alert invites set up in your server.

/alert-invites webhook url <webhook_url>

Set a custom webhook url for alert invites.

/alert-invites webhook secret

Get your webhook secret.

/alert-invites webhook reset-secret

Reset your webhook secret to a random MD5 hash.

/alert-invites webhook test

Send a test webhook request.

Webhooks

Webhooks allow you to receive real-time alert-invite events from our servers.

By creating a webhook, you can specify a URL for us to send an HTTP POST when a new alert-invite occur. This POST request will contain the relevant data from the user (user that reached n invites) and the guild in JSON format. It will also have the following headers:

Authorization: [webhook secret]

Where the webhook secret is an 64-character hash that can be used to guarantee that it was us who sent the request.

It's important you don't share or expose your webhook secret

Triggers

TriggerDescription

reached

When any member of your server has reached a specific amount of invitations that is configured as an alert invitation.

Sample Webhook Payload

{
   "user":{
      "username": "martim13",
      "id": "645298246469681152",
      "avatar": "https://cdn.discordapp.com/avatars/645298246469681152/df10136fa04bedac1547f5f4f1f6b8c8.png",
      "discriminator": "0070",
      "bot": false,
   },
   "invites": 99,
   "guild_id": "876491871680073758",
   "type": "reached"
}

Last updated