Skip to main content
WEBHOOK
benefit_grant.revoked
{
  "type": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "is_granted": true,
    "is_revoked": true,
    "subscription_id": "<string>",
    "order_id": "<string>",
    "customer_id": "<string>",
    "benefit_id": "<string>",
    "customer": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "external_id": "usr_1337",
      "email": "<string>",
      "email_verified": true,
      "name": "John Doe",
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "postal_code": "<string>",
        "city": "<string>",
        "state": "<string>"
      },
      "tax_id": {
        "[0]": "<string>"
      },
      "organization_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "type": "individual"
    },
    "benefit": {
      "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": {
        "guild_id": "<string>",
        "role_id": "<string>",
        "kick_member": true
      }
    },
    "properties": {
      "account_id": "<string>",
      "guild_id": "<string>",
      "role_id": "<string>",
      "granted_account_id": "<string>"
    },
    "granted_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "member_id": "<string>",
    "error": {
      "message": "<string>",
      "type": "<string>",
      "timestamp": "<string>"
    },
    "member": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "Jane Doe",
      "external_id": "usr_1337"
    },
    "previous_properties": {
      "account_id": "<string>",
      "guild_id": "<string>",
      "role_id": "<string>",
      "granted_account_id": "<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 benefit grant is revoked.

Discord & Slack support: Basic

​
type
string
required
Allowed value: "benefit_grant.revoked"
Example:

"benefit_grant.revoked"

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

Response

Successful Response