API v2 · Events

Finish an event

POST/v2/events/{eventId}/finish

Last updated 1 October 2026

Overview

Accepts JSON or multipart/form-data. In multipart requests, attendeeUserIds is a JSON array field and screenshot is an image file up to 10 MB. Screenshot delivery to Discord is best-effort; the bot persists durable message and attachment references. A 504 with Roblox operation status headers can occur after the event and awards are committed; check those operations rather than finishing the event again.

Permission scope: events.write
Community feature: events
Content type: application/json

Authentication

Send Authorization: Bearer YOUR_API_KEY and X-Clan-Id: COMMUNITY_ID. The community API switch and key must be enabled. The key must have the scope shown above. See authentication and key storage.

Parameters

Name	Location	Type	Required	Constraints and description
`eventId`	path	`string (uuid)`	Yes	The event's stable UUID.

Field	Type	Required	Constraints and description
`attendeeUserIds`	`integer[]`	No	max items 100, items: min 1
`screenshot`	`string (binary)`	No	—

Error responses

Status	When it is returned
400	The request was malformed or failed validation.
401	The API key is missing, malformed, or not recognised for this community.
403	The API key is disabled, lacks the required permission (insufficient_scope), or the community's subscription or tier does not cover API access or this feature (feature_unavailable). These admission-time failures create no new operation. actor-authorization-revoked additionally means the API key, its required permission, the community API switch or API-access entitlement was revoked before dispatch. Restore authorization before retrying. This response has no operation status headers or reference.
404	The requested resource does not exist.
409	The request conflicts with current state. deadline-cancelled-before-dispatch confirms the unsent operation was cancelled at its deadline. When present, status headers identify the operation; check its cancellation or failure before retrying.
429	Rate limited, queue-full admission exhaustion, or provider-rejected-429 when Roblox rejects a scheduled attempt for throttling. queue-full means no new operation was admitted. Retry-After may be absent; honor it when supplied and use bounded backoff. When Location or X-Roblox-Operation-Id is present, check that operation before repeating a synchronous write; otherwise inspect current Roblox resource state before retrying.
500	Unexpected server error.
502	Roblox authorization failed or the provider returned an upstream error. Review the connection before retrying. When present, status headers identify the failed operation; a pre-admission failure may have no operation.
503	Roblox scheduling or its budgeted live-state read is unavailable. A failed pre-admission read creates no job.
504	The event and awards are committed, but one or more Roblox rank outcomes are pending. When present, error.details.operations lists currently accessible references; check those operations and the members' Roblox state before retrying. Location and X-Roblox-Operation-Id identify the first operation in that list of accessible references; they do not represent all attendees. Details and operation headers are omitted when no reference is accessible.

Server-side examples

After HTTP requests are enabled, Roblox Lua uses HttpService:GetSecret() from a server Script, never a LocalScript.

Request

POST

curl --request POST \
  --url 'https://api.clanlabs.co/v2/events/8ca14e0a-60cb-4b43-8a91-0c77bc521d81/finish' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'X-Clan-Id: COMMUNITY_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "attendeeUserIds": [
    1
  ],
  "screenshot": "YOUR_SCREENSHOT"
}'

Response

200

The finished event

{
  "data": {
    "eventId": "00000000-0000-4000-8000-000000000000",
    "name": "EXAMPLE_NAME",
    "type": {
      "id": "128d8545-92ce-46d5-9f04-6ed803bbd351",
      "name": "Training",
      "quota": {
        "hostPoints": 1,
        "coHostPoints": 1
      },
      "experience": {
        "hostExperience": 1,
        "coHostExperience": 1,
        "attendeeExperience": 1
      },
      "defaultMentionRoleId": "YOUR_DEFAULT_MENTION_ROLE_ID"
    },
    "location": "YOUR_LOCATION",
    "status": "Scheduled",
    "host": {
      "discordId": "YOUR_DISCORD_ID",
      "robloxId": 1234567,
      "robloxName": "PixelComet482"
    },
    "coHost": {
      "discordId": "YOUR_DISCORD_ID",
      "robloxId": 1234567,
      "robloxName": "PixelComet482"
    },
    "mentionRoleId": "YOUR_MENTION_ROLE_ID",
    "notes": "YOUR_NOTES",
    "attendees": [
      {
        "discordId": "YOUR_DISCORD_ID",
        "robloxId": 1234567,
        "robloxName": "PixelComet482"
      }
    ],
    "proof": {
      "channelId": "YOUR_CHANNEL_ID",
      "messageId": "YOUR_MESSAGE_ID",
      "attachmentId": "YOUR_ATTACHMENT_ID",
      "filename": "YOUR_FILENAME",
      "contentType": "YOUR_CONTENT_TYPE",
      "size": 1
    },
    "announcement": {
      "channelId": "YOUR_CHANNEL_ID",
      "messageId": "YOUR_MESSAGE_ID"
    },
    "startedAt": 1735689600000,
    "finishedAt": 1735689600000,
    "cancelledAt": 1735689600000,
    "createdAt": 1735689600000,
    "lastUpdatedAt": 1735689600000
  }
}

Finish an event | Clan Labs API

Finish an event

Overview

Authentication

Parameters

Request body

Error responses

Rate limits

Response

OverviewCopy link to overview

AuthenticationCopy link to authentication

ParametersCopy link to parameters

Request bodyCopy link to request body

Error responsesCopy link to error responses

Rate limitsCopy link to rate limits

Related endpointsCopy link to related endpoints

Response

Overview

Authentication

Parameters

Request body

Error responses

Rate limits

Related endpoints