MemorySync
API Reference · Control-plane API

Update Webhook

Replace supported webhook endpoint fields while preserving organization and project isolation.

Endpoint contract

PATCH/org/webhooks/{endpoint_id}
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:write scope.
Resource scopeThe endpoint must belong to the caller’s organization and active project context.

Request fields

FieldTypeContract
endpoint_idinteger path parameterID returned by create or list.
namestringOptional replacement name.
urlURLOptional replacement destination; validated again.
descriptionstringOptional replacement description.
eventsstring[]Optional non-empty event list.
retry_configobjectOptional replacement retry settings.
signature_configobjectOptional replacement signature settings.

Code examples

import os
from memorysync import ControlPlaneClient


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


webhook = client.update_webhook(
    51,
    name="Primary production events",
    events=["memory.created", "memory.updated"],
    project_id=os.environ["MEMORYSYNC_PROJECT_ID"],
)

Response shape

response.json
{"id":51,"name":"Primary production events","url":"https://hooks.example.com/memorysync","events":["memory.created","memory.updated"],"enabled":true,"project_id":"project_abc123","updated_at":"2026-08-01T12:00:00Z"}
  • The response is the complete public webhook representation.
  • Updating the URL reruns destination safety validation.

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 the returned representation as current state.

  5. 05

    Reconcile

    SAFE

    After an uncertain mutation, fetch or list the endpoint before repeating the update.

Security notes

Control-plane safety

Required

Keep organization controls inside trusted boundaries.

  • Authorize the endpoint ID before sending changes.
  • Review event subscriptions when changing a destination.
  • Rotate the secret through its dedicated route, not this update body.

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

List Webhooks

Find and inspect endpoint state.

Test Webhook

Verify a subscribed test event.

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
Manage Webhooks
Next →
Delete Webhook