Test Discord direct message

POST

/v1/notifications/test/discord-dm

Send a test direct message to a Discord user through the running bot

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Discord user to send a test direct message to

application/json

Discord user to send a test direct message to

discordId*string

Discord user ID to message

Match^\d{17,20}$

Default Response

application/json

Result of sending a test notification

success*boolean

Whether the test was delivered

statusCode?number

HTTP status from the target, when one responded

error?string

Why the test failed, in plain language

responseTime*number

Time the test took, in milliseconds

Example Request

curl -X POST 'http://localhost:3003/v1/notifications/test/discord-dm' \
  -H 'Content-Type: application/json' \
  -d '{
  "discordId": "string"
}'

Example Request

curl -X POST 'http://localhost:3003/v1/notifications/test/discord-dm' \  -H 'Content-Type: application/json' \  -d '{  "discordId": "string"}'

Example ResponseSchema

{
  "success": true,
  "statusCode": 0,
  "error": "string",
  "responseTime": 0
}

{  "success": true,  "statusCode": 0,  "error": "string",  "responseTime": 0}