Skip to main content
WEBHOOK
benefit.created
{
  "type": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "description": "<string>",
    "selectable": true,
    "deletable": true,
    "organization_id": "<string>",
    "metadata": {},
    "properties": {
      "note": "<string>"
    }
  }
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Sent when a new benefit is created.

Discord & Slack support: Basic

​
type
string
required
Allowed value: "benefit.created"
Example:

"benefit.created"

​
timestamp
string<date-time>
required
​
data
BenefitCustom · object
required

A benefit of type custom.

Use it to grant any kind of benefit that doesn't fit in the other types.

Response

Successful Response