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

Path	JSON Type	Format	Description
`id`	`string`	Version 4 UUID	The subscription ID
`created`	`string`	ISO 8601 timestamp	The instant the subscription was created at
`lastModified`	`string`	ISO 8601 timestamp	The instant the subscription was last modified at
`type`	`string`	Subscription Type	The type of subscription

{
  "id" : "0000d4fc-007f-4971-a07e-149d1a6e1c4d",
  "created" : "2026-09-14T06:12:17.637167",
  "lastModified" : "2026-09-14T06:12:17.637169",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c"
    }
  }
}

Formats

Subscription Type

string

Value	Description
`ALL`	Triggers notifications for all resource events
`ALERTS`	Triggers notifications for resource alert events only
`NONE`	Does not trigger any notifications

Requests

View all subscriptions

GET /api/subscriptions

Returns all subscriptions for the authenticated user profile.

Examples

cURL
Python (requests)

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

import requests

url = "https://app.meltano.com:443/api/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "created" : "2026-09-14T06:12:17.637167",
      "lastModified" : "2026-09-14T06:12:17.783025",
      "type" : "ALERTS",
      "_embedded" : {
        "channel" : {
          "name" : "matatika-limited",
          "description" : "Matatika Limited",
          "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
        },
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
          "type" : "PUT"
        },
        "channel" : {
          "href" : "https://app.meltano.com/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c"
        }
      }
    }, {
      "id" : "a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
      "created" : "2026-09-14T06:12:18.053046",
      "lastModified" : "2026-09-14T06:12:18.053048",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        },
        "dataset" : {
          "id" : "fab1cb6a-7b56-401c-92ce-e74a4cb02616",
          "published" : "2026-09-14T06:12:12.198812",
          "alias" : "simple-bar-chart",
          "workspaceId" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
          "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-09-14T06:12:12.216966",
          "score" : 1.0
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
          "type" : "PUT"
        },
        "dataset" : {
          "href" : "https://app.meltano.com/api/datasets/fab1cb6a-7b56-401c-92ce-e74a4cb02616"
        }
      }
    }, {
      "id" : "9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
      "created" : "2026-09-14T06:12:23.86616",
      "lastModified" : "2026-09-14T06:12:23.866162",
      "type" : "ALL",
      "_embedded" : {
        "subscriberProfile" : {
          "id" : "auth0|6a21dc7aa1db2e036a222942",
          "name" : "sit+prod@meltano.com",
          "handle" : "@sit+prod"
        },
        "pipeline" : {
          "id" : "ee6ad14e-3726-420e-ae16-b4a6dabe23e9",
          "label" : "SIT-generated-pipeline",
          "name" : "sit-generated-pipeline",
          "lastModified" : "2026-09-14T06:12:18.629586"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
          "type" : "DELETE"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
          "type" : "PUT"
        },
        "pipeline" : {
          "href" : "https://app.meltano.com/api/pipelines/ee6ad14e-3726-420e-ae16-b4a6dabe23e9"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.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
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54/members/subscriptions' -i -X GET

import requests

url = "https://app.meltano.com:443/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54/members/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription collection with HAL links.

{
  "_embedded" : {
    "subscriptions" : [ {
      "id" : "bd3699b2-691e-4500-9ada-c0a8d63ed00c",
      "created" : "2026-09-14T06:12:24.011908",
      "lastModified" : "2026-09-14T06:12:24.01191",
      "type" : "ALL",
      "_embedded" : {
        "subscriberWorkspace" : {
          "id" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
          "name" : "Test Workspace [2026-09-14T06:12:11.396428462]"
        },
        "workspace" : {
          "id" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
          "name" : "Test Workspace [2026-09-14T06:12:11.396428462]"
        }
      },
      "_links" : {
        "self" : {
          "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c"
        },
        "update subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c",
          "type" : "PUT"
        },
        "delete subscription" : {
          "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c",
          "type" : "DELETE"
        },
        "workspace" : {
          "href" : "https://app.meltano.com/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54/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
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d' -i -X GET

import requests

url = "https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "0000d4fc-007f-4971-a07e-149d1a6e1c4d",
  "created" : "2026-09-14T06:12:17.637167",
  "lastModified" : "2026-09-14T06:12:17.637169",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c"
    }
  }
}

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

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether 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
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54/subscriptions?allMembers=true' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54/subscriptions?allMembers=true"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "bd3699b2-691e-4500-9ada-c0a8d63ed00c",
  "created" : "2026-09-14T06:12:24.011908478",
  "lastModified" : "2026-09-14T06:12:24.011910028",
  "type" : "ALL",
  "_embedded" : {
    "subscriberWorkspace" : {
      "id" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
      "name" : "Test Workspace [2026-09-14T06:12:11.396428462]"
    },
    "workspace" : {
      "id" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
      "name" : "Test Workspace [2026-09-14T06:12:11.396428462]"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c",
      "type" : "PUT"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/bd3699b2-691e-4500-9ada-c0a8d63ed00c",
      "type" : "DELETE"
    },
    "workspace" : {
      "href" : "https://app.meltano.com/api/workspaces/da7d6cf4-adba-49cb-aecc-e6348884db54"
    }
  }
}

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

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to channel events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "0000d4fc-007f-4971-a07e-149d1a6e1c4d",
  "created" : "2026-09-14T06:12:17.637167149",
  "lastModified" : "2026-09-14T06:12:17.637169215",
  "type" : "ALL",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c"
    }
  }
}

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

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to dataset events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/datasets/fab1cb6a-7b56-401c-92ce-e74a4cb02616/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/datasets/fab1cb6a-7b56-401c-92ce-e74a4cb02616/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
  "created" : "2026-09-14T06:12:18.053046083",
  "lastModified" : "2026-09-14T06:12:18.053047708",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    },
    "dataset" : {
      "id" : "fab1cb6a-7b56-401c-92ce-e74a4cb02616",
      "published" : "2026-09-14T06:12:12.198812",
      "alias" : "simple-bar-chart",
      "workspaceId" : "da7d6cf4-adba-49cb-aecc-e6348884db54",
      "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-09-14T06:12:12.216966",
      "score" : 1.0
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/a5b8a6bf-fe13-4e14-9637-90f37d98d7eb",
      "type" : "PUT"
    },
    "dataset" : {
      "href" : "https://app.meltano.com/api/datasets/fab1cb6a-7b56-401c-92ce-e74a4cb02616"
    }
  }
}

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

Parameter	Required	Format	Default Value	Description
`allMembers`	No	Boolean	`false`	Whether or not to subscribe the workspace to pipeline events, enabling notifications for all members by default (applicable for the workspace owner only)

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/pipelines/ee6ad14e-3726-420e-ae16-b4a6dabe23e9/subscriptions' -i -X POST \
    -H 'Content-Type: application/json'

import requests

url = "https://app.meltano.com:443/api/pipelines/ee6ad14e-3726-420e-ae16-b4a6dabe23e9/subscriptions"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
  "created" : "2026-09-14T06:12:23.86616002",
  "lastModified" : "2026-09-14T06:12:23.866161857",
  "type" : "ALL",
  "_embedded" : {
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    },
    "pipeline" : {
      "id" : "ee6ad14e-3726-420e-ae16-b4a6dabe23e9",
      "label" : "SIT-generated-pipeline",
      "name" : "sit-generated-pipeline",
      "lastModified" : "2026-09-14T06:12:18.629586"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/9a3a7ed5-7b59-43cb-838c-a7109610d1b8",
      "type" : "PUT"
    },
    "pipeline" : {
      "href" : "https://app.meltano.com/api/pipelines/ee6ad14e-3726-420e-ae16-b4a6dabe23e9"
    }
  }
}

Update a subscription

PUT /api/subscriptions/{subscription-id}

Updates the subscription {subscription-id}.

Prerequisites

Subscription {subscription-id} must exist

Body

Path	JSON Type	Format	Description
`type`	`string`	Subscription Type	The type of subscription

{
  "type" : "ALERTS"
}

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d' -i -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "type" : "ALERTS"
}'

import requests

url = "https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"

data = {
  "type" : "ALERTS"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("PUT", url, headers=headers, data=data)

print(response.text.encode('utf8'))

Response

200 OK

Subscription with HAL links.

{
  "id" : "0000d4fc-007f-4971-a07e-149d1a6e1c4d",
  "created" : "2026-09-14T06:12:17.637167",
  "lastModified" : "2026-09-14T06:12:17.783024615",
  "type" : "ALERTS",
  "_embedded" : {
    "channel" : {
      "name" : "matatika-limited",
      "description" : "Matatika Limited",
      "picture" : "https://cdn.auth0.com/avatars/ml.png?ssl=1"
    },
    "subscriberProfile" : {
      "id" : "auth0|6a21dc7aa1db2e036a222942",
      "name" : "sit+prod@meltano.com",
      "handle" : "@sit+prod"
    }
  },
  "_links" : {
    "self" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"
    },
    "delete subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "DELETE"
    },
    "update subscription" : {
      "href" : "https://app.meltano.com/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d",
      "type" : "PUT"
    },
    "channel" : {
      "href" : "https://app.meltano.com/api/channels/e094063c-ff0a-4ec8-8ec5-50fa770c2a0c"
    }
  }
}

Remove a subscription

DELETE /api/subscriptions/{subscription-id}

Removes the subscription {subscription-id}.

Prerequisites

Subscription {subscription-id} must exist

Examples

cURL
Python (requests)

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d' -i -X DELETE

import requests

url = "https://app.meltano.com:443/api/subscriptions/0000d4fc-007f-4971-a07e-149d1a6e1c4d"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("DELETE", url, headers=headers)

print(response.text.encode('utf8'))

Response

204 No Content

No response body provided.

Objects​

Subscription​

Formats​

Subscription Type​

Requests​

View all subscriptions​

Examples

Response​

View all member subscriptions to a workspace​

Prerequisites​

Examples

Response​

View a subscription​

Prerequisites​

Examples

Response​

Subscribe to a workspace​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a channel​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a dataset​

Prerequisites​

Query Parameters​

Examples

Response​

Subscribe to a pipeline​

Prerequisites​

Query Parameters​

Examples

Response​

Update a subscription​

Prerequisites​

Body​

Examples

Response​

Remove a subscription​

Prerequisites​

Examples

Response​

Objects

Subscription

Formats

Subscription Type

Requests

View all subscriptions

Response

View all member subscriptions to a workspace

Prerequisites

Response

View a subscription

Prerequisites

Response

Subscribe to a workspace

Prerequisites

Query Parameters

Response

Subscribe to a channel

Prerequisites

Query Parameters

Response

Subscribe to a dataset

Prerequisites

Query Parameters

Response

Subscribe to a pipeline

Prerequisites

Query Parameters

Response

Update a subscription

Prerequisites

Body

Response

Remove a subscription

Prerequisites

Response