MemorySync
API Reference · Control-plane API

List Webhooks

List webhook endpoints for the current organization and strict project context with aggregate health fields.

Endpoint contract

GET/org/webhooks
200 OK

Use the exact method and path shown above. Paths are relative to the API base URL.

Authentication, permission, and scope

ControlRequired contract
AuthenticationBearer access token.
Permission or scopewebhooks.manage capability and webhooks:read scope.
Resource scopeWith X-Project-ID, only that project’s webhooks are returned; without it, only organization-wide endpoints are returned.

Request fields

FieldTypeContract
X-Project-IDheaderOptional strict project selector.
Request bodynoneNo request body is accepted.

Code examples

import os
from memorysync import ControlPlaneClient


client = ControlPlaneClient(
    base_url="https://api.memorysync.io",
    access_token=os.environ["MEMORYSYNC_ACCESS_TOKEN"],
)


webhooks = client.list_webhooks(
    project_id=os.environ["MEMORYSYNC_PROJECT_ID"],
)

Response shape

response.json
{"endpoints":[{"id":51,"name":"Production events","url":"https://hooks.example.com/memorysync","events":["memory.created"],"enabled":true,"success_rate":99.5,"project_id":"project_abc123"}],"total_endpoints":1,"active_endpoints":1,"total_deliveries":240,"avg_success_rate":99.5,"failing_endpoints":0}
  • The list never returns the raw signing secret.
  • Project selection is strict rather than a union with organization-wide endpoints.

Status outcomes

HTTP outcomes
2xx
Request completed

Read the operation-specific response and persist only fields needed by the task.

400 / 422
Correct the request

Fix invalid path, query, or body fields before trying again.

401 / 403
Access denied

Refresh authentication or verify the required organization permission and scope.

404
Unavailable in scope

Treat the resource as unavailable without revealing whether it exists elsewhere.

429 / 5xx
Keep the action recoverable

Use returned retry metadata when present and reconcile uncertain mutations before repeating them.

Production handling

Production request path
  1. 01

    Authorize

    APP

    Confirm the signed-in principal may perform this product action.

  2. 02

    Validate

    INPUT

    Validate identifiers and body fields before sending the request.

  3. 03

    Call

    SDK

    Use the named ControlPlaneClient method or equivalent HTTPS request from a trusted application context.

  4. 04

    Inspect

    RESULT

    Use endpoint IDs for updates, tests, delivery inspection, and replay.

  5. 05

    Reconcile

    SAFE

    Render failing and success-rate fields as operational signals, not guaranteed delivery.

Security notes

Control-plane safety

Required

Keep organization controls inside trusted boundaries.

  • Resolve project selection from trusted application state.
  • Do not expose destination URLs to unauthorized users.
  • Keep webhook-management permission separate from payload consumption.

Avoid

Do not weaken the route contract in client code.

  • Do not expose bearer or refresh tokens in URLs, logs, or public clients.
  • Do not accept organization, member, project, or resource IDs without application authorization.
  • Do not treat returned data as trusted HTML, prompt instructions, or proof of application authorization.

Related reference

Create Webhook

Register a protected endpoint.

Webhook Deliveries

Inspect delivery history.

Authentication

Compare bearer-authenticated control-plane clients with the memory API-key client.

API Overview

Choose the SDK client and authentication contract for the operation.

Was this page helpful?
← Previous
Create Webhook
Next →
Manage Webhooks