API Reference

Webhooks

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Send a test event

webhooks.ping(strwebhook_id, WebhookPingParams**kwargs) -> WebhookPingResponse

POST/v2/webhooks/{teamId}/{webhookId}/ping

Fire-and-forget test delivery through the async dispatcher. The webhook must be enabled and verified.

ParametersExpand Collapse

team_id: Optional[str]

formatuuid

webhook_id: str

formatuuid

data: Optional[Dict[str, object]]

Arbitrary JSON payload body.

event: Optional[str]

Event name to send.

ReturnsExpand Collapse

class WebhookPingResponse: …

dispatched: bool

event: str

webhook_id: str

formatuuid

Send a test event

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
)
response = client.webhooks.ping(
    webhook_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.webhook_id)

200 example

{
  "dispatched": true,
  "event": "event",
  "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Returns Examples

200 example

{
  "dispatched": true,
  "event": "event",
  "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}