MEmetorial
Callbacks

Update callback

Updates the name, description or metadata of a callback. Everything else about a callback is derived from its integration provider - set callbacks.status to disabled there to tear it down.

patch/callbacks/{callback_id}

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Path parameters

callback_idstring required

Unique identifier of the callback.

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Request body

namestring

Updated display name

descriptionstring nullable

Updated description

metadataobject nullable

Updated custom metadata

Example request

{
  "name": "Staging GitHub Events",
  "description": "Repository events for the staging workspace"
}

Response

Successful response

object'callback' required

String representing the object's type

idstring required

Unique callback identifier

status'active' | 'archived' | 'deleted' required

Callback lifecycle status. Archived once callbacks are disabled on the integration provider.

namestring required

Display name for the callback

descriptionstring nullable required

Optional callback description

metadataobject nullable required

Custom key-value pairs for storing additional callback metadata

integration_idstring required

Integration this callback belongs to

integration_provider_idstring required

Integration provider this callback was created for

created_atstring date-time required

Timestamp when the callback was created

updated_atstring date-time required

Timestamp when the callback was last updated

Example response

{
  "id": "cbk_4dEfGhJkLmNpQrSt",
  "name": "Production GitHub Events",
  "description": "Repository events for the production workspace",
  "integration_id": "int_2bCdEfGhJkLmNpQr",
  "integration_provider_id": "inp_3cDeFgHjKlMnPqRs",
  "provider": {
    "id": "pro_5gHjKlMnPqRsTuVw",
    "name": "GitHub",
    "description": "Connect to GitHub repositories, issues, and pull requests",
    "slug": "github",
    "created_at": "2025-09-15T10:30:00.000Z",
    "updated_at": "2026-01-10T14:45:00.000Z"
  },
  "created_at": "2025-09-15T10:30:00.000Z",
  "updated_at": "2026-01-10T14:45:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.