{ "opencollection": "1.0.0", "info": { "name": "PostHog actions subscriptions API", "version": "1.0.0" }, "items": [ { "info": { "name": "subscriptions", "type": "folder" }, "items": [ { "info": { "name": "environments_subscriptions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/", "params": [ { "name": "created_by", "value": "", "type": "query", "description": "Filter by creator user UUID." }, { "name": "dashboard", "value": "", "type": "query", "description": "Filter by dashboard ID." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight", "value": "", "type": "query", "description": "Filter by insight ID." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "resource_type", "value": "", "type": "query", "description": "Filter by subscription resource: insight vs dashboard export." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "target_type", "value": "", "type": "query", "description": "Filter by delivery channel (email, Slack, or webhook)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "environments_subscriptions_test_delivery_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/test-delivery/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "List subscription deliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/subscriptions/:subscription_id/deliveries/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "status", "value": "", "type": "query", "description": "Return only deliveries in this run status (starting, completed, failed, or skipped)." }, { "name": "subscription_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Paginated delivery history for a subscription. Requires premium subscriptions." }, { "info": { "name": "Retrieve subscription delivery", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/subscriptions/:subscription_id/deliveries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this subscription delivery." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "subscription_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch one delivery row by id." }, { "info": { "name": "subscriptions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/", "params": [ { "name": "created_by", "value": "", "type": "query", "description": "Filter by creator user UUID." }, { "name": "dashboard", "value": "", "type": "query", "description": "Filter by dashboard ID." }, { "name": "insight", "value": "", "type": "query", "description": "Filter by insight ID." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "resource_type", "value": "", "type": "query", "description": "Filter by subscription resource: insight vs dashboard export." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "target_type", "value": "", "type": "query", "description": "Filter by delivery channel (email, Slack, or webhook)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "subscriptions_test_delivery_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/test-delivery/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] } ], "bundled": true }