API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a webhook

webhooks.update(strwebhook_id, WebhookUpdateParams**kwargs) -> WebhookUpdateResponse

PATCH/v2/webhooks/{teamId}/{webhookId}

Updates mutable fields. Changing url resets verification and re-runs the handshake.

ParametersExpand Collapse

team_id: Optional[str]

formatuuid

webhook_id: str

formatuuid

description: Optional[str]

maxLength1000

enabled: Optional[bool]

name: Optional[str]

minLength1

maxLength255

url: Optional[str]

formaturi

ReturnsExpand Collapse

class WebhookUpdateResponse: …

A webhook plus the status of a verification handshake enqueued by this request.

verification: Optional[WebhookUpdateResponseVerification]

Status of the verification handshake enqueued by this request. The handshake runs asynchronously in the dispatcher; poll the webhook (its verified flag flips to true on success) to observe the outcome.

status: Literal["pending"]

Always pending at the moment of the response — the dispatcher has been asked to run the handshake but has not reported back yet.

Update a webhook

Python

HTTP

TypeScript

Python

Go

CLI Tool

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
webhook = client.webhooks.update(
    webhook_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(webhook)

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "enabled": true,
  "name": "name",
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "url": "https://example.com",
  "verified": true,
  "description": "description",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "verification_token": "verification_token",
  "verified_at": "2019-12-27T18:11:19.117Z",
  "verification": {
    "status": "pending"
  }
}

Returns Examples

200 example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "enabled": true,
  "name": "name",
  "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "url": "https://example.com",
  "verified": true,
  "description": "description",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "verification_token": "verification_token",
  "verified_at": "2019-12-27T18:11:19.117Z",
  "verification": {
    "status": "pending"
  }
}