Log a new event

POST

events

curl --request POST \
  --url https://api.dingify.workers.dev/api/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "You got a new payment",
  "channel": "new-channel-name",
  "userId": "user-999",
  "icon": "🎉",
  "notify": true,
  "tags": {
    "plan": "premium",
    "cycle": "monthly"
  }
}'

{
  "ok": true,
  "message": "Event logged!",
  "event": {
    "id": "clwj5o92a0001adaz8mcbxqja",
    "name": "You got a new payment",
    "channelId": "new-channel-name",
    "userId": "user-999",
    "icon": "icon_event.png",
    "notify": true,
    "tags": {
      "Networking": "Yes",
      "Tech": "Yes"
    },
    "createdAt": "2024-05-23T11:14:27.682Z"
  }
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

Details of the event to log.

name

string

required

The name of the event.

Example:

"You got a new payment"

channel

string

required

The channel name where the event is registered.

Example:

"new-channel-name"

userId

string

required

The ID of the user associated with the event.

Example:

"user-999"

notify

boolean

required

Whether to notify users about the event.

Example:

true

icon

string

An optional icon representing the event.

Example:

"🎉"

Response

201

application/json

Event logged successfully.

boolean

Example:

true

message

string

Example:

"Event logged!"

event

object

event.id

string

required

The ID of the event.

Example:

"clwj5o92a0001adaz8mcbxqja"

event.name

string

required

The name of the event.

Example:

"You got a new payment"

event.channelId

string

required

The ID of the channel associated with the event.

Example:

"new-channel-name"

event.userId

string

required

The ID of the user associated with the event.

Example:

"user-999"

event.icon

string

required

An optional icon for visual representation of the event.

Example:

"icon_event.png"

event.notify

boolean

required

Flag indicating whether users should be notified about the event.

Example:

true

event.createdAt

string

required

The timestamp when the event was created.

Example:

"2024-05-23T11:14:27.682Z"

event.tags

object

Tags providing additional context or categorization for the event.

Example:

{ "Networking": "Yes", "Tech": "Yes" }

Get Events

curl --request POST \
  --url https://api.dingify.workers.dev/api/events \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "You got a new payment",
  "channel": "new-channel-name",
  "userId": "user-999",
  "icon": "🎉",
  "notify": true,
  "tags": {
    "plan": "premium",
    "cycle": "monthly"
  }
}'

{
  "ok": true,
  "message": "Event logged!",
  "event": {
    "id": "clwj5o92a0001adaz8mcbxqja",
    "name": "You got a new payment",
    "channelId": "new-channel-name",
    "userId": "user-999",
    "icon": "icon_event.png",
    "notify": true,
    "tags": {
      "Networking": "Yes",
      "Tech": "Yes"
    },
    "createdAt": "2024-05-23T11:14:27.682Z"
  }
}

API Documentation

Events

Authorizations

Body

Response