Skip to content
Glitter AI

A guide is created

POST

A guide was created in the team, or moved into it from another team. Drafts count; placement.team_guides says whether it is in Team Guides.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “ Header Parameters ”
X-Glitter-Event
required
string

The event name, the same as type in the body.

X-Glitter-Delivery
required
string format: uuid

One id per attempt; the same event retried carries a new one.

X-Glitter-Signature
required
string

sha256= followed by the hex HMAC-SHA256 of the raw body with the endpoint’s signing key.

User-Agent
required
string

Glitter-Webhooks/1

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
team_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
organization_id
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
type
required
string
Allowed value: guide.created
data
required
object
guide
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
title
required
string | null
description
required
string | null
permalink
required
string | null
updated_at
required
string | null
team_id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
folder_id
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
language
required
string
url
required

The guide in Glitter.

string format: uri
placement
required
object
team_guides
required

In Team Guides (moved out of Drafts).

boolean
public_link
required

Readable by anyone with the share link.

boolean
changed
required

Columns that changed, for guide.updated; empty otherwise.

Array<string>

Example 

{
  "id": "0d6c1a2b-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
  "created_at": "2026-10-11T13:20:45Z",
  "team_id": "4b1e7c2a-9d3f-4e8b-a1c6-0f5d2e7b9a34",
  "organization_id": "9c0a4b2d-1e3f-4a5b-9c7d-2e4f6a8b0c1d",
  "type": "guide.created",
  "data": {
    "guide": {
      "id": "7d2e5f1a-3c4b-4d6e-8f9a-0b1c2d3e4f5a",
      "title": "Set up SSO in Okta",
      "description": null,
      "permalink": "set-up-sso-in-okta-7d2e5f1a",
      "url": "https://www.glitter.io/share/7d2e5f1a-3c4b-4d6e-8f9a-0b1c2d3e4f5a",
      "updated_at": "2026-10-11T13:20:12+00:00",
      "team_id": "4b1e7c2a-9d3f-4e8b-a1c6-0f5d2e7b9a34",
      "folder_id": null,
      "language": "english"
    },
    "placement": {
      "team_guides": true,
      "public_link": false
    },
    "changed": []
  }
}

Responses

Section titled “ Responses ”

2XX

Section titled “ 2XX ”

Received. Any 2xx within 10 seconds counts; anything else is retried.