Skip to content

feat: add webhook subscription and event client helpers #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
George-iam merged 1 commit into from
Feb 28, 2026
Merged

feat: add webhook subscription and event client helpers #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,19 @@ with AxmeClient(config) as client:
idempotency_key="reply-001",
)
print(replied)
subscription = client.upsert_webhook_subscription(
{
"callback_url": "https://integrator.example/webhooks/axme",
"event_types": ["inbox.thread_created"],
"active": True,
}
)
print(subscription)
events = client.publish_webhook_event(
{"event_type": "inbox.thread_created", "source": "sdk-example", "payload": {"thread_id": "t-1"}},
owner_agent="agent://example/receiver",
)
print(events["event_id"])
```

## Development
Expand Down
40 changes: 40 additions & 0 deletions axme_sdk/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,46 @@ def reply_inbox_thread(
)
return self._parse_json_response(response)

def upsert_webhook_subscription(
self,
payload: dict[str, Any],
*,
idempotency_key: str | None = None,
) -> dict[str, Any]:
headers: dict[str, str] | None = None
if idempotency_key is not None:
headers = {"Idempotency-Key": idempotency_key}
response = self._http.post("/v1/webhooks/subscriptions", json=payload, headers=headers)
return self._parse_json_response(response)

def list_webhook_subscriptions(self, *, owner_agent: str | None = None) -> dict[str, Any]:
params: dict[str, str] | None = None
if owner_agent is not None:
params = {"owner_agent": owner_agent}
response = self._http.get("/v1/webhooks/subscriptions", params=params)
return self._parse_json_response(response)

def delete_webhook_subscription(self, subscription_id: str, *, owner_agent: str | None = None) -> dict[str, Any]:
params: dict[str, str] | None = None
if owner_agent is not None:
params = {"owner_agent": owner_agent}
response = self._http.delete(f"/v1/webhooks/subscriptions/{subscription_id}", params=params)
return self._parse_json_response(response)

def publish_webhook_event(self, payload: dict[str, Any], *, owner_agent: str | None = None) -> dict[str, Any]:
params: dict[str, str] | None = None
if owner_agent is not None:
params = {"owner_agent": owner_agent}
response = self._http.post("/v1/webhooks/events", params=params, json=payload)
return self._parse_json_response(response)

def replay_webhook_event(self, event_id: str, *, owner_agent: str | None = None) -> dict[str, Any]:
params: dict[str, str] | None = None
if owner_agent is not None:
params = {"owner_agent": owner_agent}
response = self._http.post(f"/v1/webhooks/events/{event_id}/replay", params=params)
return self._parse_json_response(response)

def _parse_json_response(self, response: httpx.Response) -> dict[str, Any]:
if response.status_code >= 400:
self._raise_http_error(response)
Expand Down
126 changes: 126 additions & 0 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,21 @@ def _thread_payload() -> dict[str, object]:
}


def _webhook_subscription_payload() -> dict[str, object]:
return {
"subscription_id": "44444444-4444-4444-8444-444444444444",
"owner_agent": "agent://owner",
"callback_url": "https://integrator.example/webhooks/axme",
"event_types": ["inbox.thread_created"],
"active": True,
"description": "sdk-test",
"created_at": "2026-02-28T00:00:00Z",
"updated_at": "2026-02-28T00:00:01Z",
"revoked_at": None,
"secret_hint": "****hint",
}


def test_health_success() -> None:
def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "GET"
Expand Down Expand Up @@ -220,3 +235,114 @@ def handler(request: httpx.Request) -> httpx.Response:
assert exc_info.value.retry_after == 30
assert isinstance(exc_info.value.body, dict)
assert exc_info.value.body["message"] == "too many"


def test_upsert_webhook_subscription_success() -> None:
subscription = _webhook_subscription_payload()
request_payload = {
"callback_url": "https://integrator.example/webhooks/axme",
"event_types": ["inbox.thread_created"],
"active": True,
}

def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "POST"
assert request.url.path == "/v1/webhooks/subscriptions"
assert request.headers["idempotency-key"] == "wh-1"
assert request.read() == b'{"callback_url":"https://integrator.example/webhooks/axme","event_types":["inbox.thread_created"],"active":true}'
return httpx.Response(200, json={"ok": True, "subscription": subscription})

client = _client(handler)
assert client.upsert_webhook_subscription(request_payload, idempotency_key="wh-1") == {
"ok": True,
"subscription": subscription,
}


def test_list_webhook_subscriptions_success() -> None:
subscription = _webhook_subscription_payload()

def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "GET"
assert request.url.path == "/v1/webhooks/subscriptions"
assert request.url.params.get("owner_agent") == "agent://owner"
return httpx.Response(200, json={"ok": True, "subscriptions": [subscription]})

client = _client(handler)
assert client.list_webhook_subscriptions(owner_agent="agent://owner") == {
"ok": True,
"subscriptions": [subscription],
}


def test_delete_webhook_subscription_success() -> None:
subscription_id = "44444444-4444-4444-8444-444444444444"

def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "DELETE"
assert request.url.path == f"/v1/webhooks/subscriptions/{subscription_id}"
assert request.url.params.get("owner_agent") == "agent://owner"
return httpx.Response(200, json={"ok": True, "subscription_id": subscription_id, "revoked_at": "2026-02-28T00:00:03Z"})

client = _client(handler)
assert client.delete_webhook_subscription(subscription_id, owner_agent="agent://owner") == {
"ok": True,
"subscription_id": subscription_id,
"revoked_at": "2026-02-28T00:00:03Z",
}


def test_publish_webhook_event_success() -> None:
event_id = "33333333-3333-4333-8333-333333333333"
request_payload = {"event_type": "inbox.thread_created", "source": "sdk-test", "payload": {"thread_id": "t-1"}}

def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "POST"
assert request.url.path == "/v1/webhooks/events"
assert request.url.params.get("owner_agent") == "agent://owner"
return httpx.Response(
200,
json={
"ok": True,
"accepted_at": "2026-02-28T00:00:01Z",
"event_type": "inbox.thread_created",
"source": "sdk-test",
"owner_agent": "agent://owner",
"event_id": event_id,
"queued_deliveries": 1,
"processed_deliveries": 1,
"delivered": 1,
"pending": 0,
"dead_lettered": 0,
},
)

client = _client(handler)
assert client.publish_webhook_event(request_payload, owner_agent="agent://owner")["event_id"] == event_id


def test_replay_webhook_event_success() -> None:
event_id = "33333333-3333-4333-8333-333333333333"

def handler(request: httpx.Request) -> httpx.Response:
assert request.method == "POST"
assert request.url.path == f"/v1/webhooks/events/{event_id}/replay"
assert request.url.params.get("owner_agent") == "agent://owner"
return httpx.Response(
200,
json={
"ok": True,
"event_id": event_id,
"owner_agent": "agent://owner",
"event_type": "inbox.thread_created",
"queued_deliveries": 1,
"processed_deliveries": 1,
"delivered": 1,
"pending": 0,
"dead_lettered": 0,
"replayed_at": "2026-02-28T00:00:02Z",
},
)

client = _client(handler)
assert client.replay_webhook_event(event_id, owner_agent="agent://owner")["event_id"] == event_id