GEgetmembrane
AppEventSubscriptions

Subscribe to internal event subscription by id

post/app-event-subscriptions/{id}/subscribe

Request

  • Base URL
    https://api.getmembrane.com
  • URL
    https://api.getmembrane.com/app-event-subscriptions/{id}/subscribe
  • Auth
    HTTP bearer

Path parameters

idstring required

ID

Response

idstring required

Internal database ID of the element. Assigned by the API; unique per element.

namestring required

Display name. Always present in API responses (filled by API if not set on create).

uuidstring

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

keystring

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

descriptionstring

Optional human-readable description.

metaobject

Optional key-value metadata.

state'BUILDING' | 'CLIENT_ACTION_REQUIRED' | 'CONFIGURATION_ERROR' | 'SETUP_FAILED' | 'READY' | 'DISCONNECTING'

Current lifecycle or health state (e.g. READY, SETUP_FAILED, CONFIGURATION_ERROR, BUILDING). Set by the engine during setup and validation.

revisionstring required
createdAtstring

ISO date when the element was created.

updatedAtstring

ISO date when the element was last updated.

archivedAtstring
isDeactivatedboolean

When true, setup is skipped and the element is treated as inactive (e.g. when dependencies are deactivated or the element is archived).

isReadOnlyboolean

When true, the element cannot be modified (e.g. published package elements or elements from another workspace).

userIdstring required
tenantIdstring
appEventTypeIdstring required
instanceKeystring
isSubscribedboolean required
webhookUristring required
subscriptionResponseobject

Changes

No recorded changes to this operation across all 2 revisions of this API.