Skip to main content
POST
Update Skill

Authorizations

api_key
string
header
required

Body

application/json
oId
string
required
name
string
Required string length: 1 - 64
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string
Maximum string length: 1024
content
string
contentJson
object | null
status
enum<string>
Available options:
draft,
published
active
boolean
archived
boolean
writeBatchId
string
Pattern: ^[A-Za-z0-9._~-]{1,200}$
delivery
object | null

Replace where every run of this skill sends its result (workspace owners): slack (a channel Octave's Slack app can reach, by id or name), slackDm and email (people, by work email, at most 20 each), webhook (a public https URL), mode digest or per_item. null clears it; leave it out to keep it. A first webhook returns its signing secret once as webhookSecret. Skill runs send at most 1,000 Slack posts, Slack DMs and emails a day per workspace; webhooks are not limited.

rotateWebhookSecret
boolean

With delivery: make the webhook a new signing secret, returned once as webhookSecret (the old one stops working).

Response

Skill updated successfully

_metadata
object
required
data
object
required
delivery
object | null
required

Where every run of this workspace skill sends its result unless the run names somewhere else; null when nowhere (or the plan has no skill runs). A webhook's signing secret is never returned; webhook.signed says one is set.

webhookSecret
string | null
required

The webhook's signing secret, only when this update made one (a first webhook, or a rotation). Shown once and never returned again: store it now.