Skip to main content

Subscriptions

Subscriptions are a declaration of interest in a particular resource, allowing a user to receive notifications when certain events occur. The events that trigger notifications are controlled by the type of subscription.

Objects​

Subscription​

PathJSON TypeFormatDescription
idstringVersion 4 UUIDThe subscription ID
createdstringISO 8601 timestampThe instant the subscription was created at
lastModifiedstringISO 8601 timestampThe instant the subscription was last modified at
typestringSubscription TypeThe type of subscription
{
  "id" : "f3a28108-5064-4252-a124-64cca3084ab4",
  "created" : "2026-08-06T14:22:28.849511",
  "lastModified" : "2026-08-06T14:22:28.849512",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://staging.meltano.com/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17"
    }
  }
}

Formats​

Subscription Type​

string

ValueDescription
ALLTriggers notifications for all resource events
ALERTSTriggers notifications for resource alert events only
NONEDoes not trigger any notifications

Requests​

View all subscriptions​

GET /api/subscriptions

Returns all subscriptions for the authenticated user profile.

Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/subscriptions' -i -X GET

Response​

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "f3a28108-5064-4252-a124-64cca3084ab4",
      "created" : "2026-08-06T14:22:28.849511",
      "lastModified" : "2026-08-06T14:22:28.952815",
      "type" : "ALERTS",
      "_embedded" : {
        "channel" : {
          "name" : "matatika-limited",
          "description" : "Matatika Limited",
          "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
        },
        "subscriberProfile" : {
          "id" : "auth0|6a205ea86a76a69d8a3babcb",
          "name" : "sit@meltano.com",
          "handle" : "@sit1"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4"
        },
        "delete subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
          "type" : "PUT"
        },
        "channel" : {
          "href" : "https://staging.meltano.com/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17"
        }
      }
    }, {
      "id" : "7c94c207-ac28-4bef-b334-4ee5142eaf89",
      "created" : "2026-08-06T14:22:29.174413",
      "lastModified" : "2026-08-06T14:22:29.174415",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a205ea86a76a69d8a3babcb",
          "name" : "sit@meltano.com",
          "handle" : "@sit1"
        },
        "dataset" : {
          "id" : "b73a81f4-b8b1-4723-8d3e-3bf5a15e3dcd",
          "published" : "2026-08-06T14:22:23.48392",
          "alias" : "simple-bar-chart",
          "workspaceId" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
          "source" : "matatika-limited",
          "title" : "How many people have visited our website?",
          "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
          "questions" : "[''This is my question'', ''this is second question'']",
          "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
          "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
          "likeCount" : 0,
          "likedByProfiles" : [ ],
          "commentCount" : 0,
          "viewCount" : 0,
          "created" : "2026-08-06T14:22:23.498236",
          "score" : 1.0
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89"
        },
        "delete subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89",
          "type" : "PUT"
        },
        "dataset" : {
          "href" : "https://staging.meltano.com/api/datasets/b73a81f4-b8b1-4723-8d3e-3bf5a15e3dcd"
        }
      }
    }, {
      "id" : "51361b0e-ac3e-4697-9b00-e2547b87eacc",
      "created" : "2026-08-06T14:22:34.737121",
      "lastModified" : "2026-08-06T14:22:34.737123",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a205ea86a76a69d8a3babcb",
          "name" : "sit@meltano.com",
          "handle" : "@sit1"
        },
        "pipeline" : {
          "id" : "78b36daa-7dac-4e87-a46c-7a4a552b54c4",
          "label" : "SIT-generated-pipeline",
          "name" : "sit-generated-pipeline",
          "lastModified" : "2026-08-06T14:22:29.54048"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc"
        },
        "delete subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc",
          "type" : "PUT"
        },
        "pipeline" : {
          "href" : "https://staging.meltano.com/api/pipelines/78b36daa-7dac-4e87-a46c-7a4a552b54c4"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

View all member subscriptions to a workspace​

GET /api/workspaces/{workspace-id}/members/subscriptions

Returns all member subscriptions to the workspace {workspace-id}.

Prerequisites​

  • Workspace {workspace-id} must exist
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/a392c78d-0fde-4e9c-a0e8-874ffc687802/members/subscriptions' -i -X GET

Response​

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "a87aef4d-3186-468a-a83c-e6d90f4205fd",
      "created" : "2026-08-06T14:22:34.882911",
      "lastModified" : "2026-08-06T14:22:34.882912",
      "type" : "ALL",
      "_embedded" : {
        "subscriberWorkspace" : {
          "id" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
          "name" : "Test Workspace [2026-08-06T14:22:22.900862159]"
        },
        "workspace" : {
          "id" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
          "name" : "Test Workspace [2026-08-06T14:22:22.900862159]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd"
        },
        "update subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd",
          "type" : "PUT"
        },
        "delete subscription" : {
          "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd",
          "type" : "DELETE"
        },
        "workspace" : {
          "href" : "https://staging.meltano.com/api/workspaces/a392c78d-0fde-4e9c-a0e8-874ffc687802"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/workspaces/a392c78d-0fde-4e9c-a0e8-874ffc687802/members/subscriptions?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

View a subscription​

GET /api/subscriptions/{subscription-id}

Returns the subscription {subscription-id}.

Prerequisites​

  • Subscription {subscription-id} must exist
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4' -i -X GET

Response​

200 OK

Subscription with HAL links.

{
  "id" : "f3a28108-5064-4252-a124-64cca3084ab4",
  "created" : "2026-08-06T14:22:28.849511",
  "lastModified" : "2026-08-06T14:22:28.849512",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://staging.meltano.com/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17"
    }
  }
}

Subscribe to a workspace​

POST /api/workspaces/{workspace-id}/subscriptions

Subscribes the authenticated user profile to the workspace {workspace-id}.

By default, the subscription is configured for all workspace events (see Subscription Type for more information).

Prerequisites​

  • Workspace {workspace-id} must exist

Query Parameters​

ParameterRequiredFormatDefault ValueDescription
allMembersNoBooleanfalseWhether or not to subscribe the workspace to workspace events, in order to enable workspace-wide notifications for all members by default (applicable for the workspace owner only)
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/workspaces/a392c78d-0fde-4e9c-a0e8-874ffc687802/subscriptions?allMembers=true' -i -X POST \
    -H 'Content-Type: application/json'

Response​

200 OK

Subscription with HAL links.

{
  "id" : "a87aef4d-3186-468a-a83c-e6d90f4205fd",
  "created" : "2026-08-06T14:22:34.882910984",
  "lastModified" : "2026-08-06T14:22:34.882911979",
  "type" : "ALL",
  "_embedded" : {
    "subscriberWorkspace" : {
      "id" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
      "name" : "Test Workspace [2026-08-06T14:22:22.900862159]"
    },
    "workspace" : {
      "id" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
      "name" : "Test Workspace [2026-08-06T14:22:22.900862159]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd",
      "type" : "PUT"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/a87aef4d-3186-468a-a83c-e6d90f4205fd",
      "type" : "DELETE"
    },
    "workspace" : {
      "href" : "https://staging.meltano.com/api/workspaces/a392c78d-0fde-4e9c-a0e8-874ffc687802"
    }
  }
}

Subscribe to a channel​

POST /api/channels/{channel-id}/subscriptions

Subscribes the authenticated user profile to the channel {channel-id}.

By default, the subscription is configured for all channel events (see Subscription Type for more information).

Prerequisites​

  • Channel {channel-id} must exist

Query Parameters​

ParameterRequiredFormatDefault ValueDescription
allMembersNoBooleanfalseWhether or not to subscribe the workspace to channel events, enabling notifications for all members by default (applicable for the workspace owner only)
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

Response​

200 OK

Subscription with HAL links.

{
  "id" : "f3a28108-5064-4252-a124-64cca3084ab4",
  "created" : "2026-08-06T14:22:28.849511146",
  "lastModified" : "2026-08-06T14:22:28.849512041",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://staging.meltano.com/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17"
    }
  }
}

Subscribe to a dataset​

POST /api/datasets/{dataset-id}/subscriptions

Subscribes the authenticated user profile to the dataset {dataset-id}.

By default, the subscription is configured for all dataset events (see Subscription Type for more information).

Prerequisites​

  • Dataset {dataset-id} must exist

Query Parameters​

ParameterRequiredFormatDefault ValueDescription
allMembersNoBooleanfalseWhether or not to subscribe the workspace to dataset events, enabling notifications for all members by default (applicable for the workspace owner only)
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/datasets/b73a81f4-b8b1-4723-8d3e-3bf5a15e3dcd/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

Response​

200 OK

Subscription with HAL links.

{
  "id" : "7c94c207-ac28-4bef-b334-4ee5142eaf89",
  "created" : "2026-08-06T14:22:29.174413272",
  "lastModified" : "2026-08-06T14:22:29.174414998",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    },
    "dataset" : {
      "id" : "b73a81f4-b8b1-4723-8d3e-3bf5a15e3dcd",
      "published" : "2026-08-06T14:22:23.48392",
      "alias" : "simple-bar-chart",
      "workspaceId" : "a392c78d-0fde-4e9c-a0e8-874ffc687802",
      "source" : "matatika-limited",
      "title" : "How many people have visited our website?",
      "description" : "# Some Markdown\n- point 1\n- point 2\n- point 3\n",
      "questions" : "[''This is my question'', ''this is second question'']",
      "visualisation" : "{\"google-chart\": {\"chartType\": \"BarChart\",\"options\": {\"title\": \"Website visitors\"}}}",
      "query" : "SELECT to_char(date(report_date),'YYYYMM') as year_month, SUM(sessions) \n   FROM\n     \"google_analytics_website_overview\"\n   WHERE\n     \"google_analytics_website_overview\".\"report_date\" >= DATE(NOW()) - INTERVAL '365 DAY'\n   GROUP BY year_month\n   ORDER BY year_month ASC;",
      "likeCount" : 0,
      "likedByProfiles" : [ ],
      "commentCount" : 0,
      "viewCount" : 0,
      "created" : "2026-08-06T14:22:23.498236",
      "score" : 1.0
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/7c94c207-ac28-4bef-b334-4ee5142eaf89",
      "type" : "PUT"
    },
    "dataset" : {
      "href" : "https://staging.meltano.com/api/datasets/b73a81f4-b8b1-4723-8d3e-3bf5a15e3dcd"
    }
  }
}

Subscribe to a pipeline​

POST /api/pipelines/{pipeline-id}/subscriptions

Subscribes the authenticated user profile to the pipeline {pipeline-id}.

By default, the subscription is configured for all pipeline events (see Subscription Type for more information).

Prerequisites​

  • Pipeline {pipeline-id} must exist

Query Parameters​

ParameterRequiredFormatDefault ValueDescription
allMembersNoBooleanfalseWhether or not to subscribe the workspace to pipeline events, enabling notifications for all members by default (applicable for the workspace owner only)
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/pipelines/78b36daa-7dac-4e87-a46c-7a4a552b54c4/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

Response​

200 OK

Subscription with HAL links.

{
  "id" : "51361b0e-ac3e-4697-9b00-e2547b87eacc",
  "created" : "2026-08-06T14:22:34.737121386",
  "lastModified" : "2026-08-06T14:22:34.737122582",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    },
    "pipeline" : {
      "id" : "78b36daa-7dac-4e87-a46c-7a4a552b54c4",
      "label" : "SIT-generated-pipeline",
      "name" : "sit-generated-pipeline",
      "lastModified" : "2026-08-06T14:22:29.54048"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/51361b0e-ac3e-4697-9b00-e2547b87eacc",
      "type" : "PUT"
    },
    "pipeline" : {
      "href" : "https://staging.meltano.com/api/pipelines/78b36daa-7dac-4e87-a46c-7a4a552b54c4"
    }
  }
}

Update a subscription​

PUT /api/subscriptions/{subscription-id}

Updates the subscription {subscription-id}.

Prerequisites​

  • Subscription {subscription-id} must exist

Body​

PathJSON TypeFormatDescription
typestringSubscription TypeThe type of subscription
{
  "type" : "ALERTS"
}
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "type" : "ALERTS"
}'

Response​

200 OK

Subscription with HAL links.

{
  "id" : "f3a28108-5064-4252-a124-64cca3084ab4",
  "created" : "2026-08-06T14:22:28.849511",
  "lastModified" : "2026-08-06T14:22:28.952814975",
  "type" : "ALERTS",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a205ea86a76a69d8a3babcb",
      "name" : "sit@meltano.com",
      "handle" : "@sit1"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4"
    },
    "delete subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://staging.meltano.com/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://staging.meltano.com/api/channels/6ecde103-368f-46f9-87ea-2cc97ec38e17"
    }
  }
}

Remove a subscription​

DELETE /api/subscriptions/{subscription-id}

Removes the subscription {subscription-id}.

Prerequisites​

  • Subscription {subscription-id} must exist
Examples
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://staging.meltano.com:443/api/subscriptions/f3a28108-5064-4252-a124-64cca3084ab4' -i -X DELETE

Response​

204 No Content

No response body provided.

Github LogoEdit this page on Github