Skip to main content
WEBHOOK
api_key.updated
{
  "webhook_id": "<string>",
  "url": "<string>",
  "event": "api_key.updated",
  "resource_id": "<string>",
  "payload": {
    "id": "<string>",
    "scopes": [
      "<string>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>",
    "label": "<string>",
    "description": "<string>",
    "ip_allow_list": [
      "<string>"
    ],
    "expires_at": "<string>",
    "secret": "<string>",
    "metrics": {
      "api_key_id": "<string>",
      "total_requests": 123,
      "last_used_at": "<string>"
    }
  },
  "timestamp": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bitgpt.xyz/llms.txt

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

Headers

​
X-Webhook-Signature
string
required

Signature of the webhook event payload, used for verification.

​
X-Webhook-Timestamp
string
required

Timestamp of the webhook event, used to prevent replay attacks.

Example:

"2025-08-20 20:56:36.456"

​
X-Webhook-Event
string
required

The type of event being sent.

Example:

"payment.created"

Body

application/json
​
webhook_id
string
required

Unique identifier for the webhook

Example:

"webhook_0197b617-b4c8-773f-bbd9-3ba84dd93d70"

​
url
string<uri>
required

URL where webhook events will be sent

Example:

"https://webhook-handler.com/webhooks"

​
event
enum<string>
required

Type of webhook event that occurred

Available options:
api_key.updated
Example:

"api_key.updated"

​
resource_id
string
required

Updated Api Key identifier

Example:

"api_key_0197bd94-d729-76ef-b486-cf276509029d"

​
payload
object
required

Details of the Api Key that was updated

Example:
{
  "id": "api_key_0197c0f1-9589-7990-b421-4b806f637b0c",
  "organization_id": "org_0197c0f1-9589-7990-b421-4b806f637b0c",
  "label": "My API Key",
  "description": "Key for accessing product APIs",
  "secret": "sk_live_MDE5N2MwZjEtOTU4OS03N2U0LWJiY2YtNGQ0OWQ4YTM5NzUzX2JpdGdwdA",
  "scopes": ["products.create"],
  "ip_allow_list": ["127.0.0.1"],
  "expires_at": "2026-05-30 20:23:16",
  "created_at": "2025-06-30 15:05:47",
  "updated_at": null,
  "metrics": {
    "api_key_id": "api_key_0197c0f1-9589-7990-b421-4b806f637b0c",
    "total_requests": 150,
    "last_used_at": "2025-06-30 16:03:44"
  }
}
​
timestamp
string
required

Timestamp when the event occurred

Example:

"2025-08-20 20:56:36.456"