MEmetorial
Callbacks

Create callback

Enables callbacks for an integration provider and returns the callback it created. Only providers whose type reports triggers.status as enabled support this. Callback instances are then registered for every matching integration instance in the background.

post/callbacks

Request

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

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

integration_idstring required

Integration the integration provider belongs to

integration_provider_idstring required

Integration provider to enable callbacks for

namestring

Display name for the callback. Defaults to the name of the integration provider.

descriptionstring nullable

Description for the callback. Defaults to the description of the integration provider.

Example request

{
  "integration_id": "int_2bCdEfGhJkLmNpQr",
  "integration_provider_id": "inp_3cDeFgHjKlMnPqRs",
  "name": "Production GitHub Events",
  "description": "Repository events for the production 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.