Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat: update mgmt api docs (#51246)

supabase-supabase-autofixer[bot]61d9b7304dcc
diff --git a/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx b/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx
index 8b92471e540..a0fb04e6d94 100644
--- a/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx
+++ b/apps/docs/content/_partials/access-control/scoped_pat_mcp_tools.mdx
@@ -15,6 +15,7 @@
| `get_cost` | **Organization Settings** (Read) and **Projects (account-wide)** (Read) |
| `get_edge_function` | **Edge Functions** (Read) |
| `get_logs` | **Logs** (Read) |
+| `get_notebook` | **Notebooks** (Read) |
| `get_organization` | **Organization Settings** (Read) |
| `get_project` | **Project Settings** (Read) |
| `get_project_url` | **Project Settings** (Read) |
@@ -24,6 +25,7 @@
| `list_edge_functions` | **Edge Functions** (Read) |
| `list_extensions` | **Database** (Read) |
| `list_migrations` | **Migrations** (Read) |
+| `list_notebooks` | **Notebooks** (Read) |
| `list_organizations` | **Organizations** (Read) |
| `list_projects` | **Projects (account-wide)** (Read) |
| `list_storage_buckets` | **Storage** (Read) |
diff --git a/apps/docs/spec/api_v1_openapi.json b/apps/docs/spec/api_v1_openapi.json
index bf0ce8ff0e5..25e1ffcfa40 100644
--- a/apps/docs/spec/api_v1_openapi.json
+++ b/apps/docs/spec/api_v1_openapi.json
@@ -592,7 +592,7 @@
"description": "",
"content": {
"application/json": {
- "schema": { "$ref": "#/components/schemas/RegionsInfo_Output" }
+ "schema": { "$ref": "#/components/schemas/RegionsInfoV1_Output" }
}
}
}
@@ -6489,10 +6489,10 @@
"required": true,
"content": {
"application/vnd.denoland.eszip": {
- "schema": { "type": "string", "format": "binary" }
+ "schema": { "$ref": "#/components/schemas/V1UpdateFunctionBodyEszip" }
},
"application/json": {
- "schema": { "$ref": "#/components/schemas/V1UpdateFunctionBody" }
+ "schema": { "$ref": "#/components/schemas/V1UpdateFunctionBodyJson" }
}
}
},
@@ -8661,7 +8661,7 @@
"status"
]
},
- "RegionsInfo_Output": {
+ "RegionsInfoV1_Output": {
"type": "object",
"properties": {
"recommendations": {
@@ -12797,7 +12797,7 @@
"required": ["id", "slug", "name", "status", "version", "created_at", "updated_at"]
},
"StreamableFile": { "type": "object", "properties": {} },
- "V1UpdateFunctionBody": {
+ "V1UpdateFunctionBodyJson": {
"type": "object",
"properties": {
"name": { "type": "string" },
@@ -12810,6 +12810,13 @@
"verify_jwt": true
}
},
+ "V1UpdateFunctionBodyEszip": {
+ "type": "string",
+ "format": "binary",
+ "contentEncoding": "binary",
+ "description": "Raw Brotli-compressed ESZIP binary file.\n\n**Validation requirements** - The file must start with the four magic bytes `EZBR` (hex: `45 5A 42 52`).\n- The `ezbr_sha256` query parameter must contain the SHA-256 hash of the uploaded ESZIP payload.\n\n**Example**\n```javascript\nimport { readFile } from 'node:fs/promises';\nimport { brotliCompress } from 'node:zlib';\nimport { promisify } from 'node:util';\nimport { createHash } from 'node:crypto';\n\nconst compress = promisify(brotliCompress);\nconst marker = Buffer.from('EZBR', 'ascii');\n\nconst file = await readFile('./function.eszip');\nconst compressed = await compress(file);\n\nconst payload = Buffer.concat([marker, compressed]);\n\nconst ezbr_sha256 = createHash('sha256')\n .update(payload)\n .digest('hex');\n\nconsole.log(ezbr_sha256);\n```\n\n",
+ "examples": ["Binary Brotli-compressed ESZIP file"]
+ },
"V1StorageBucketResponse_Output": {
"type": "object",
"properties": {
@@ -13228,6 +13235,10 @@
"properties": {
"effective_cache_size": { "type": "string" },
"logical_decoding_work_mem": { "type": "string" },
+ "pg_stat_statements.max": { "type": "integer", "minimum": 100, "maximum": 45000 },
+ "pg_net.batch_size": { "type": "integer", "minimum": 0, "maximum": 32767 },
+ "autovacuum_max_workers": { "type": "integer", "minimum": 1, "maximum": 262143 },
+ "autovacuum_work_mem": { "type": "string" },
"cron.log_statement": { "type": "boolean" },
"log_autovacuum_min_duration": {
"type": "string",
@@ -13303,6 +13314,10 @@
"properties": {
"effective_cache_size": { "type": "string" },
"logical_decoding_work_mem": { "type": "string" },
+ "pg_stat_statements.max": { "type": "integer", "minimum": 100, "maximum": 45000 },
+ "pg_net.batch_size": { "type": "integer", "minimum": 0, "maximum": 32767 },
+ "autovacuum_max_workers": { "type": "integer", "minimum": 1, "maximum": 262143 },
+ "autovacuum_work_mem": { "type": "string" },
"cron.log_statement": { "type": "boolean" },
"log_autovacuum_min_duration": {
"type": "string",
diff --git a/apps/docs/spec/api_v2_openapi.json b/apps/docs/spec/api_v2_openapi.json
index fdac7fb7882..6e406dcad79 100644
--- a/apps/docs/spec/api_v2_openapi.json
+++ b/apps/docs/spec/api_v2_openapi.json
@@ -1756,7 +1756,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } }
}
@@ -1783,8 +1783,8 @@
"security": [{ "bearer": [] }],
"summary": "Assign or change an organization member role",
"tags": ["Organizations"],
- "x-allowed-plans": ["Enterprise"],
- "x-badges": [{ "name": "Only available on Enterprise", "position": "before" }],
+ "x-allowed-plans": ["Team", "Enterprise"],
+ "x-badges": [{ "name": "Only available on Team, Enterprise", "position": "before" }],
"x-endpoint-owners": ["control-plane"],
"x-fga-permissions": [["organization_admin_write"]]
}
@@ -1884,7 +1884,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } }
}
@@ -1905,10 +1905,10 @@
"security": [{ "bearer": [] }],
"summary": "Creates organization invitations",
"tags": ["Organizations Members Invitations"],
- "x-allowed-plans": ["Enterprise"],
+ "x-allowed-plans": ["Team", "Enterprise"],
"x-badges": [
{ "name": "OAuth scope: organizations:write", "position": "after" },
- { "name": "Only available on Enterprise", "position": "before" }
+ { "name": "Only available on Team, Enterprise", "position": "before" }
],
"x-endpoint-owners": ["control-plane"],
"x-fga-permissions": [["members_write"]],
@@ -1954,7 +1954,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseBody" } }
}
@@ -1975,10 +1975,10 @@
"security": [{ "bearer": [] }],
"summary": "Deletes organization invitations by email",
"tags": ["Organizations Members Invitations"],
- "x-allowed-plans": ["Enterprise"],
+ "x-allowed-plans": ["Team", "Enterprise"],
"x-badges": [
{ "name": "OAuth scope: organizations:write", "position": "after" },
- { "name": "Only available on Enterprise", "position": "before" }
+ { "name": "Only available on Team, Enterprise", "position": "before" }
],
"x-endpoint-owners": ["control-plane"],
"x-fga-permissions": [["members_write"]],
@@ -2293,19 +2293,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -2437,11 +2429,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -2480,8 +2469,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -2524,18 +2516,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -2555,7 +2542,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -2596,7 +2583,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -2614,8 +2601,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -2656,7 +2643,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -2833,19 +2820,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -2950,11 +2929,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -2993,8 +2969,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3037,18 +3016,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -3068,7 +3042,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3109,7 +3083,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -3127,8 +3101,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3169,7 +3143,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -3315,16 +3289,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"signing_secret": {
"type": "string",
@@ -3453,19 +3422,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -3571,11 +3532,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3614,8 +3572,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3658,18 +3619,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -3689,7 +3645,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3730,7 +3686,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -3748,8 +3704,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -3790,7 +3746,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -3980,19 +3936,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -4097,11 +4045,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4140,8 +4085,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4184,18 +4132,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -4214,8 +4157,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4257,8 +4200,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -4278,7 +4221,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4319,7 +4262,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -4337,8 +4280,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4379,7 +4322,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -4567,19 +4510,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -4684,11 +4619,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4727,8 +4659,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4771,18 +4706,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -4801,8 +4731,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4844,8 +4774,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -4865,7 +4795,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4906,7 +4836,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -4924,8 +4854,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -4966,7 +4896,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -5111,16 +5041,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"signing_secret": {
"type": "string",
@@ -5254,19 +5179,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -5371,11 +5288,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -5414,8 +5328,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -5458,18 +5375,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -5488,8 +5400,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -5531,8 +5443,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -5552,7 +5464,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -5593,7 +5505,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -5611,8 +5523,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -5653,7 +5565,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -5835,14 +5747,9 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": { "type": "string" },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -5864,11 +5771,79 @@
{ "type": "null" }
]
},
+ "error_code": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
+ "error_message": {
+ "anyOf": [{ "type": "string" }, { "type": "null" }]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"description": "Timestamp of the attempt."
+ },
+ "event": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "v1.project.paused",
+ "v1.project.created",
+ "v1.project.restored",
+ "v1.project.transferred",
+ "v1.project.removed",
+ "v1.project.restarted",
+ "v1.project.status.changed",
+ "v1.project.backup.started",
+ "v1.project.branch.created",
+ "v1.project.branch.updated",
+ "v1.project.branch.removed",
+ "v1.organization.member.invitation.created",
+ "v1.organization.member.invitation.canceled",
+ "v1.organization.member.added",
+ "v1.organization.member.removed",
+ "v1.organization.member.role.assigned",
+ "v1.organization.member.role.removed",
+ "v1.organization.member.role.updated",
+ "v1.organization.billing.plan.upgraded",
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "organization_slug": {
+ "type": "string",
+ "pattern": "^[\\w-]+$",
+ "description": "Organization slug",
+ "example": "tsrqponmlkjihgfedcba"
+ },
+ "project_ref": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "description": "Project ref",
+ "example": "abcdefghijklmnopqrst"
+ },
+ { "type": "null" }
+ ]
+ }
+ },
+ "required": ["organization_slug", "project_ref"],
+ "description": "Final data sent to the consumer."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "description": "Timestamp of event publication."
+ }
+ },
+ "required": ["type", "payload", "timestamp"]
}
},
"required": [
@@ -5878,7 +5853,10 @@
"response_code",
"response_headers",
"response_body",
- "attempt_timestamp"
+ "error_code",
+ "error_message",
+ "attempt_timestamp",
+ "event"
]
}
},
@@ -5988,11 +5966,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6031,8 +6006,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6075,18 +6053,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -6105,8 +6078,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6148,8 +6121,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -6169,7 +6142,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6210,7 +6183,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -6228,8 +6201,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6270,7 +6243,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -6414,13 +6387,10 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": {
- "type": "string",
- "const": "bad_request.endpoint.test.disabled"
- },
+ "code": { "type": "string", "const": "endpoint_disabled" },
"message": {
"type": "string",
- "const": "Bad Request: Endpoint is disabled"
+ "const": "Webhook endpoint is disabled"
},
"description": { "type": "string" },
"links": {
@@ -6462,11 +6432,11 @@
"id": { "type": "string" },
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.wrong_event_type"
+ "const": "endpoint_event_type_not_subscribed"
},
"message": {
"type": "string",
- "const": "Bad Request: Provided event type is not subscribed to by the endpoint"
+ "const": "Webhook endpoint is not subscribed to this event type"
},
"description": { "type": "string" },
"links": {
@@ -6512,18 +6482,18 @@
"EndpointTestDisabled": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.disabled",
- "message": "Bad Request: Endpoint is disabled",
- "description": "Endpoint is disabled, to send test event endpoint must first be enabled."
+ "code": "endpoint_disabled",
+ "description": "Endpoint is disabled, to send test event endpoint must first be enabled.",
+ "message": "Webhook endpoint is disabled"
}
}
},
"EndpointTestWrongEventType": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.wrong_event_type",
- "message": "Bad Request: Provided event type is not subscribed to by the endpoint",
- "description": "Only event types that the endpoint is subscribed to can be specified."
+ "code": "endpoint_event_type_not_subscribed",
+ "description": "Only event types that the endpoint is subscribed to can be specified.",
+ "message": "Webhook endpoint is not subscribed to this event type"
}
}
}
@@ -6602,11 +6572,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6645,8 +6612,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6689,18 +6659,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -6719,8 +6684,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6762,8 +6727,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -6783,7 +6748,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6824,7 +6789,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -6842,8 +6807,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -6884,7 +6849,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -6976,7 +6941,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -6998,29 +6962,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
}
},
"required": ["type"]
@@ -7114,14 +7058,9 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": { "type": "string" },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -7143,6 +7082,10 @@
{ "type": "null" }
]
},
+ "error_code": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
+ "error_message": {
+ "anyOf": [{ "type": "string" }, { "type": "null" }]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
@@ -7153,7 +7096,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -7175,29 +7117,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
},
"payload": {
"type": "object",
@@ -7242,6 +7164,8 @@
"response_code",
"response_headers",
"response_body",
+ "error_code",
+ "error_message",
"attempt_timestamp",
"event"
]
@@ -7326,11 +7250,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7369,8 +7290,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7413,18 +7337,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -7443,8 +7362,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.delivery" },
- "message": { "type": "string", "const": "Not Found: Delivery not found" },
+ "code": { "type": "string", "const": "delivery_not_found" },
+ "message": { "type": "string", "const": "Webhook delivery not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7486,8 +7405,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -7507,7 +7426,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7548,7 +7467,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -7566,8 +7485,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7608,7 +7527,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -7810,11 +7729,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7853,8 +7769,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7897,18 +7816,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -7927,8 +7841,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.delivery" },
- "message": { "type": "string", "const": "Not Found: Delivery not found" },
+ "code": { "type": "string", "const": "delivery_not_found" },
+ "message": { "type": "string", "const": "Webhook delivery not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -7970,8 +7884,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -7991,7 +7905,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8032,7 +7946,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -8050,8 +7964,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8092,7 +8006,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -8286,19 +8200,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -8430,11 +8336,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8473,8 +8376,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8517,18 +8423,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -8548,7 +8449,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8589,7 +8490,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -8607,8 +8508,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8649,7 +8550,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -8824,19 +8725,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -8941,11 +8834,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -8984,8 +8874,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9028,18 +8921,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -9059,7 +8947,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9100,7 +8988,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -9118,8 +9006,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9160,7 +9048,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -9306,16 +9194,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"signing_secret": {
"type": "string",
@@ -9442,19 +9325,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -9560,11 +9435,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9603,8 +9475,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9647,18 +9522,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -9678,7 +9548,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9719,7 +9589,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -9737,8 +9607,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -9779,7 +9649,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -9967,19 +9837,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -10084,11 +9946,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10127,8 +9986,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10171,18 +10033,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -10201,8 +10058,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10244,8 +10101,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -10265,7 +10122,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10306,7 +10163,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -10324,8 +10181,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10366,7 +10223,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -10552,19 +10409,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -10669,11 +10518,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10712,8 +10558,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10756,18 +10605,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -10786,8 +10630,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10829,8 +10673,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -10850,7 +10694,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10891,7 +10735,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -10909,8 +10753,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -10951,7 +10795,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -11096,16 +10940,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"signing_secret": {
"type": "string",
@@ -11237,19 +11076,11 @@
"example": [{ "type": "v1.project.paused" }]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
- "example": { "Authorization": "Bearer example_token" }
+ "example": { "Authorization": "Bearer example_token" },
+ "type": "object",
+ "propertyNames": { "type": "string", "pattern": "^[a-zA-Z0-9-]+$" },
+ "additionalProperties": { "type": "string" }
},
"created_by": {
"type": "string",
@@ -11354,11 +11185,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -11397,8 +11225,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -11441,18 +11272,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -11471,8 +11297,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -11514,8 +11340,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -11535,7 +11361,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -11576,7 +11402,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -11594,8 +11420,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -11636,7 +11462,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -11816,14 +11642,9 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": { "type": "string" },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -11845,11 +11666,79 @@
{ "type": "null" }
]
},
+ "error_code": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
+ "error_message": {
+ "anyOf": [{ "type": "string" }, { "type": "null" }]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"description": "Timestamp of the attempt."
+ },
+ "event": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "v1.project.paused",
+ "v1.project.created",
+ "v1.project.restored",
+ "v1.project.transferred",
+ "v1.project.removed",
+ "v1.project.restarted",
+ "v1.project.status.changed",
+ "v1.project.backup.started",
+ "v1.project.branch.created",
+ "v1.project.branch.updated",
+ "v1.project.branch.removed",
+ "v1.organization.member.invitation.created",
+ "v1.organization.member.invitation.canceled",
+ "v1.organization.member.added",
+ "v1.organization.member.removed",
+ "v1.organization.member.role.assigned",
+ "v1.organization.member.role.removed",
+ "v1.organization.member.role.updated",
+ "v1.organization.billing.plan.upgraded",
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "organization_slug": {
+ "type": "string",
+ "pattern": "^[\\w-]+$",
+ "description": "Organization slug",
+ "example": "tsrqponmlkjihgfedcba"
+ },
+ "project_ref": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "description": "Project ref",
+ "example": "abcdefghijklmnopqrst"
+ },
+ { "type": "null" }
+ ]
+ }
+ },
+ "required": ["organization_slug", "project_ref"],
+ "description": "Final data sent to the consumer."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "description": "Timestamp of event publication."
+ }
+ },
+ "required": ["type", "payload", "timestamp"]
}
},
"required": [
@@ -11859,7 +11748,10 @@
"response_code",
"response_headers",
"response_body",
- "attempt_timestamp"
+ "error_code",
+ "error_message",
+ "attempt_timestamp",
+ "event"
]
}
},
@@ -11969,11 +11861,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12012,8 +11901,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12056,18 +11948,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -12086,8 +11973,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12129,8 +12016,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -12150,7 +12037,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12191,7 +12078,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -12209,8 +12096,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12251,7 +12138,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -12393,13 +12280,10 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": {
- "type": "string",
- "const": "bad_request.endpoint.test.disabled"
- },
+ "code": { "type": "string", "const": "endpoint_disabled" },
"message": {
"type": "string",
- "const": "Bad Request: Endpoint is disabled"
+ "const": "Webhook endpoint is disabled"
},
"description": { "type": "string" },
"links": {
@@ -12441,11 +12325,11 @@
"id": { "type": "string" },
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.wrong_event_type"
+ "const": "endpoint_event_type_not_subscribed"
},
"message": {
"type": "string",
- "const": "Bad Request: Provided event type is not subscribed to by the endpoint"
+ "const": "Webhook endpoint is not subscribed to this event type"
},
"description": { "type": "string" },
"links": {
@@ -12491,18 +12375,18 @@
"EndpointTestDisabled": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.disabled",
- "message": "Bad Request: Endpoint is disabled",
- "description": "Endpoint is disabled, to send test event endpoint must first be enabled."
+ "code": "endpoint_disabled",
+ "description": "Endpoint is disabled, to send test event endpoint must first be enabled.",
+ "message": "Webhook endpoint is disabled"
}
}
},
"EndpointTestWrongEventType": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.wrong_event_type",
- "message": "Bad Request: Provided event type is not subscribed to by the endpoint",
- "description": "Only event types that the endpoint is subscribed to can be specified."
+ "code": "endpoint_event_type_not_subscribed",
+ "description": "Only event types that the endpoint is subscribed to can be specified.",
+ "message": "Webhook endpoint is not subscribed to this event type"
}
}
}
@@ -12581,11 +12465,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12624,8 +12505,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12668,18 +12552,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -12698,8 +12577,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.endpoint" },
- "message": { "type": "string", "const": "Not Found: Endpoint not found" },
+ "code": { "type": "string", "const": "endpoint_not_found" },
+ "message": { "type": "string", "const": "Webhook endpoint not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12741,8 +12620,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -12762,7 +12641,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12803,7 +12682,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -12821,8 +12700,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -12863,7 +12742,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -12955,7 +12834,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -12977,29 +12855,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
}
},
"required": ["type"]
@@ -13091,14 +12949,9 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": { "type": "string" },
- "additionalProperties": { "type": "string" }
- },
- { "type": "null" }
- ],
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": { "type": "string" },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -13120,6 +12973,10 @@
{ "type": "null" }
]
},
+ "error_code": { "anyOf": [{ "type": "string" }, { "type": "null" }] },
+ "error_message": {
+ "anyOf": [{ "type": "string" }, { "type": "null" }]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
@@ -13130,7 +12987,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -13152,29 +13008,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
},
"payload": {
"type": "object",
@@ -13219,6 +13055,8 @@
"response_code",
"response_headers",
"response_body",
+ "error_code",
+ "error_message",
"attempt_timestamp",
"event"
]
@@ -13303,11 +13141,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13346,8 +13181,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13390,18 +13228,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -13420,8 +13253,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.delivery" },
- "message": { "type": "string", "const": "Not Found: Delivery not found" },
+ "code": { "type": "string", "const": "delivery_not_found" },
+ "message": { "type": "string", "const": "Webhook delivery not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13463,8 +13296,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -13484,7 +13317,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13525,7 +13358,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -13543,8 +13376,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13585,7 +13418,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -13785,11 +13618,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.permission_denied" },
- "message": {
- "type": "string",
- "const": "Forbidden: Permission denied"
- },
+ "code": { "type": "string", "const": "forbidden" },
+ "message": { "type": "string", "const": "Forbidden" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13828,8 +13658,11 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "forbidden.access_disabled" },
- "message": { "type": "string", "const": "Forbidden: Access disabled" },
+ "code": { "type": "string", "const": "webhooks_access_disabled" },
+ "message": {
+ "type": "string",
+ "const": "Webhooks access is disabled for this organization or project"
+ },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13872,18 +13705,13 @@
},
"examples": {
"PermissionDenied": {
- "value": {
- "error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
- }
- }
+ "value": { "error": { "code": "forbidden", "message": "Forbidden" } }
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -13902,8 +13730,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "not_found.delivery" },
- "message": { "type": "string", "const": "Not Found: Delivery not found" },
+ "code": { "type": "string", "const": "delivery_not_found" },
+ "message": { "type": "string", "const": "Webhook delivery not found" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -13945,8 +13773,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -13966,7 +13794,7 @@
"properties": {
"id": { "type": "string" },
"code": { "type": "string", "const": "request_timeout" },
- "message": { "type": "string", "const": "Request Timeout" },
+ "message": { "type": "string", "const": "Request timed out" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -14007,7 +13835,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "request_timeout", "message": "Request Timeout" }
+ "error": { "code": "request_timeout", "message": "Request timed out" }
}
}
}
@@ -14025,8 +13853,8 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string", "const": "too_many_requests" },
- "message": { "type": "string", "const": "Too Many Requests" },
+ "code": { "type": "string", "const": "rate_limit_exceeded" },
+ "message": { "type": "string", "const": "Rate limit exceeded" },
"description": { "type": "string" },
"links": {
"type": "object",
@@ -14067,7 +13895,7 @@
"examples": {
"Default example": {
"value": {
- "error": { "code": "too_many_requests", "message": "Too Many Requests" }
+ "error": { "code": "rate_limit_exceeded", "message": "Rate limit exceeded" }
}
}
}
@@ -14308,7 +14136,51 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string" },
+ "code": {
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
+ },
"message": { "type": "string" },
"description": { "type": "string" },
"links": {
@@ -14329,7 +14201,32 @@
"meta": { "type": "object", "additionalProperties": {} },
"issues": {
"type": "array",
- "items": { "$ref": "#/components/schemas/ErrorResponseBodyAPIErrorObject" }
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "code": { "type": "string" },
+ "message": { "type": "string" },
+ "description": { "type": "string" },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": { "type": "string" },
+ "rel": { "type": "string" },
+ "title": { "type": "string" },
+ "type": { "type": "string" },
+ "describedby": { "type": "string" },
+ "meta": { "type": "object", "additionalProperties": {} }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": { "type": "object", "additionalProperties": {} }
+ },
+ "required": ["code", "message"]
+ }
}
},
"required": ["code", "message"],
@@ -15217,6 +15114,12 @@
"properties": {
"effective_cache_size": { "type": "string" },
"logical_decoding_work_mem": { "type": "string" },
+ "autovacuum_max_workers": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 262143
+ },
+ "autovacuum_work_mem": { "type": "string" },
"log_autovacuum_min_duration": {
"type": "string",
"description": "Default unit: ms",
@@ -15311,7 +15214,17 @@
"pattern": "^(-?[0-9]+(?:\\.[0-9]+)?)(us|ms|s|min|h|d)?$"
},
"hot_standby_feedback": { "type": "boolean" },
- "cron_log_statement": { "type": "boolean" }
+ "cron_log_statement": { "type": "boolean" },
+ "pg_net_batch_size": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 32767
+ },
+ "pg_stat_statements_max": {
+ "type": "integer",
+ "minimum": 100,
+ "maximum": 45000
+ }
},
"description": "Postgres parameter overrides. Empty when the project runs entirely on defaults."
}
@@ -17123,7 +17036,51 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string" },
+ "code": {
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
+ },
"message": { "type": "string" },
"description": { "type": "string" },
"links": {
@@ -17579,7 +17536,51 @@
"type": "object",
"properties": {
"id": { "type": "string" },
- "code": { "type": "string" },
+ "code": {
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
+ },
"message": { "type": "string" },
"description": { "type": "string" },
"links": {
@@ -17607,7 +17608,44 @@
"propertyNames": { "type": "string" },
"additionalProperties": {}
},
- "issues": { "type": "array", "items": { "$ref": "#/components/schemas/APIErrorObject" } }
+ "issues": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "id": { "type": "string" },
+ "code": { "type": "string" },
+ "message": { "type": "string" },
+ "description": { "type": "string" },
+ "links": {
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": { "type": "string" },
+ "rel": { "type": "string" },
+ "title": { "type": "string" },
+ "type": { "type": "string" },
+ "describedby": { "type": "string" },
+ "meta": {
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "propertyNames": { "type": "string" },
+ "additionalProperties": {}
+ }
+ },
+ "required": ["code", "message"]
+ }
+ }
},
"required": ["code", "message"]
}
diff --git a/apps/docs/spec/mcp_tools_permissions.json b/apps/docs/spec/mcp_tools_permissions.json
index 09ade5b3bee..9cb4d5dddca 100644
--- a/apps/docs/spec/mcp_tools_permissions.json
+++ b/apps/docs/spec/mcp_tools_permissions.json
@@ -30,6 +30,8 @@
"get_storage_config": [["storage_config_read"]],
"update_storage_config": [["storage_config_write"]],
"list_storage_buckets": [["storage_read"]],
+ "list_notebooks": [["project_notebooks_read"]],
+ "get_notebook": [["project_notebooks_read"]],
"get_cost": [["organization_admin_read", "projects_read"]],
"confirm_cost": [[]],
"search_docs": [[]]
diff --git a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
index 3b7fab9e590..b0a6a464a4c 100644
--- a/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v1_openapi_deparsed.json
@@ -885,7 +885,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RegionsInfo_Output"
+ "$ref": "#/components/schemas/RegionsInfoV1_Output"
}
}
}
@@ -9313,13 +9313,12 @@
"content": {
"application/vnd.denoland.eszip": {
"schema": {
- "type": "string",
- "format": "binary"
+ "$ref": "#/components/schemas/V1UpdateFunctionBodyEszip"
}
},
"application/json": {
"schema": {
- "$ref": "#/components/schemas/V1UpdateFunctionBody"
+ "$ref": "#/components/schemas/V1UpdateFunctionBodyJson"
}
}
}
@@ -12271,7 +12270,7 @@
"status"
]
},
- "RegionsInfo_Output": {
+ "RegionsInfoV1_Output": {
"type": "object",
"properties": {
"recommendations": {
@@ -18923,7 +18922,7 @@
"type": "object",
"properties": {}
},
- "V1UpdateFunctionBody": {
+ "V1UpdateFunctionBodyJson": {
"type": "object",
"properties": {
"name": {
@@ -18942,6 +18941,13 @@
"verify_jwt": true
}
},
+ "V1UpdateFunctionBodyEszip": {
+ "type": "string",
+ "format": "binary",
+ "contentEncoding": "binary",
+ "description": "Raw Brotli-compressed ESZIP binary file.\n\n**Validation requirements** - The file must start with the four magic bytes `EZBR` (hex: `45 5A 42 52`).\n- The `ezbr_sha256` query parameter must contain the SHA-256 hash of the uploaded ESZIP payload.\n\n**Example**\n```javascript\nimport { readFile } from 'node:fs/promises';\nimport { brotliCompress } from 'node:zlib';\nimport { promisify } from 'node:util';\nimport { createHash } from 'node:crypto';\n\nconst compress = promisify(brotliCompress);\nconst marker = Buffer.from('EZBR', 'ascii');\n\nconst file = await readFile('./function.eszip');\nconst compressed = await compress(file);\n\nconst payload = Buffer.concat([marker, compressed]);\n\nconst ezbr_sha256 = createHash('sha256')\n .update(payload)\n .digest('hex');\n\nconsole.log(ezbr_sha256);\n```\n\n",
+ "examples": ["Binary Brotli-compressed ESZIP file"]
+ },
"V1StorageBucketResponse_Output": {
"type": "object",
"properties": {
@@ -19531,6 +19537,24 @@
"logical_decoding_work_mem": {
"type": "string"
},
+ "pg_stat_statements.max": {
+ "type": "integer",
+ "minimum": 100,
+ "maximum": 45000
+ },
+ "pg_net.batch_size": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 32767
+ },
+ "autovacuum_max_workers": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 262143
+ },
+ "autovacuum_work_mem": {
+ "type": "string"
+ },
"cron.log_statement": {
"type": "boolean"
},
@@ -19681,6 +19705,24 @@
"logical_decoding_work_mem": {
"type": "string"
},
+ "pg_stat_statements.max": {
+ "type": "integer",
+ "minimum": 100,
+ "maximum": 45000
+ },
+ "pg_net.batch_size": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 32767
+ },
+ "autovacuum_max_workers": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 262143
+ },
+ "autovacuum_work_mem": {
+ "type": "string"
+ },
"cron.log_statement": {
"type": "boolean"
},
diff --git a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
index d22e27c0f8d..160b57c7e4e 100644
--- a/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
+++ b/apps/docs/spec/transforms/api_v2_openapi_deparsed.json
@@ -2440,7 +2440,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": {
"schema": {
@@ -2487,10 +2487,10 @@
],
"summary": "Assign or change an organization member role",
"tags": ["Organizations"],
- "x-allowed-plans": ["Enterprise"],
+ "x-allowed-plans": ["Team", "Enterprise"],
"x-badges": [
{
- "name": "Only available on Enterprise",
+ "name": "Only available on Team, Enterprise",
"position": "before"
}
],
@@ -2624,7 +2624,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": {
"schema": {
@@ -2661,14 +2661,14 @@
],
"summary": "Creates organization invitations",
"tags": ["Organizations Members Invitations"],
- "x-allowed-plans": ["Enterprise"],
+ "x-allowed-plans": ["Team", "Enterprise"],
"x-badges": [
{
"name": "OAuth scope: organizations:write",
"position": "after"
},
{
- "name": "Only available on Enterprise",
+ "name": "Only available on Team, Enterprise",
"position": "before"
}
],
@@ -2724,7 +2724,7 @@
}
},
"402": {
- "description": "This feature requires the Enterprise organization plan.",
+ "description": "This feature requires the Team, or Enterprise organization plan.",
"content": {
"application/json": {
"schema": {
@@ -2761,14 +2761,14 @@
],
"summary": "Deletes organization invitations by email",
"tags": ["Organizations Members Invitations"],
- "x-allowed-plans": ["Enterprise"],
+ "x-allowed-plans": ["Team", "Enterprise"],
"x-badges": [
{
"name": "OAuth scope: organizations:write",
"position": "after"
},
{
- "name": "Only available on Enterprise",
+ "name": "Only available on Team, Enterprise",
"position": "before"
}
],
@@ -3165,24 +3165,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -3384,11 +3377,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -3452,11 +3445,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -3526,16 +3519,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -3562,7 +3555,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -3630,7 +3623,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -3653,11 +3646,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -3724,8 +3717,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -3947,24 +3940,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -4111,11 +4097,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -4179,11 +4165,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -4253,16 +4239,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -4289,7 +4275,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -4357,7 +4343,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -4380,11 +4366,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -4451,8 +4437,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -4643,24 +4629,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"signing_secret": {
@@ -4799,24 +4778,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -4964,11 +4936,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -5032,11 +5004,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -5106,16 +5078,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -5142,7 +5114,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -5210,7 +5182,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -5233,11 +5205,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -5304,8 +5276,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -5540,24 +5512,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -5704,11 +5669,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -5772,11 +5737,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -5846,16 +5811,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -5878,11 +5843,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -5949,8 +5914,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -5977,7 +5942,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -6045,7 +6010,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -6068,11 +6033,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -6139,8 +6104,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -6373,24 +6338,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -6537,11 +6495,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -6605,11 +6563,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -6679,16 +6637,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -6711,11 +6669,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -6782,8 +6740,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -6810,7 +6768,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -6878,7 +6836,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -6901,11 +6859,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -6972,8 +6930,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -7163,24 +7121,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"signing_secret": {
@@ -7327,24 +7278,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -7491,11 +7435,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -7559,11 +7503,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -7633,16 +7577,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -7665,11 +7609,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -7736,8 +7680,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -7764,7 +7708,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -7832,7 +7776,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -7855,11 +7799,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -7926,8 +7870,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -8146,20 +8090,13 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -8187,11 +8124,97 @@
}
]
},
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "error_message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"description": "Timestamp of the attempt."
+ },
+ "event": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "v1.project.paused",
+ "v1.project.created",
+ "v1.project.restored",
+ "v1.project.transferred",
+ "v1.project.removed",
+ "v1.project.restarted",
+ "v1.project.status.changed",
+ "v1.project.backup.started",
+ "v1.project.branch.created",
+ "v1.project.branch.updated",
+ "v1.project.branch.removed",
+ "v1.organization.member.invitation.created",
+ "v1.organization.member.invitation.canceled",
+ "v1.organization.member.added",
+ "v1.organization.member.removed",
+ "v1.organization.member.role.assigned",
+ "v1.organization.member.role.removed",
+ "v1.organization.member.role.updated",
+ "v1.organization.billing.plan.upgraded",
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "organization_slug": {
+ "type": "string",
+ "pattern": "^[\\w-]+$",
+ "description": "Organization slug",
+ "example": "tsrqponmlkjihgfedcba"
+ },
+ "project_ref": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "description": "Project ref",
+ "example": "abcdefghijklmnopqrst"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": ["organization_slug", "project_ref"],
+ "description": "Final data sent to the consumer."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "description": "Timestamp of event publication."
+ }
+ },
+ "required": ["type", "payload", "timestamp"]
}
},
"required": [
@@ -8201,7 +8224,10 @@
"response_code",
"response_headers",
"response_body",
- "attempt_timestamp"
+ "error_code",
+ "error_message",
+ "attempt_timestamp",
+ "event"
]
}
},
@@ -8380,11 +8406,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -8448,11 +8474,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -8522,16 +8548,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -8554,11 +8580,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -8625,8 +8651,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -8653,7 +8679,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -8721,7 +8747,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -8744,11 +8770,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -8815,8 +8841,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -8999,11 +9025,11 @@
},
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.disabled"
+ "const": "endpoint_disabled"
},
"message": {
"type": "string",
- "const": "Bad Request: Endpoint is disabled"
+ "const": "Webhook endpoint is disabled"
},
"description": {
"type": "string"
@@ -9067,11 +9093,11 @@
},
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.wrong_event_type"
+ "const": "endpoint_event_type_not_subscribed"
},
"message": {
"type": "string",
- "const": "Bad Request: Provided event type is not subscribed to by the endpoint"
+ "const": "Webhook endpoint is not subscribed to this event type"
},
"description": {
"type": "string"
@@ -9141,18 +9167,18 @@
"EndpointTestDisabled": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.disabled",
- "message": "Bad Request: Endpoint is disabled",
- "description": "Endpoint is disabled, to send test event endpoint must first be enabled."
+ "code": "endpoint_disabled",
+ "description": "Endpoint is disabled, to send test event endpoint must first be enabled.",
+ "message": "Webhook endpoint is disabled"
}
}
},
"EndpointTestWrongEventType": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.wrong_event_type",
- "message": "Bad Request: Provided event type is not subscribed to by the endpoint",
- "description": "Only event types that the endpoint is subscribed to can be specified."
+ "code": "endpoint_event_type_not_subscribed",
+ "description": "Only event types that the endpoint is subscribed to can be specified.",
+ "message": "Webhook endpoint is not subscribed to this event type"
}
}
}
@@ -9272,11 +9298,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -9340,11 +9366,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -9414,16 +9440,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -9446,11 +9472,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -9517,8 +9543,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -9545,7 +9571,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -9613,7 +9639,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -9636,11 +9662,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -9707,8 +9733,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -9833,7 +9859,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -9855,29 +9880,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
}
},
"required": ["type"]
@@ -9971,20 +9976,13 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -10012,6 +10010,26 @@
}
]
},
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "error_message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
@@ -10022,7 +10040,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -10044,29 +10061,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
},
"payload": {
"type": "object",
@@ -10113,6 +10110,8 @@
"response_code",
"response_headers",
"response_body",
+ "error_code",
+ "error_message",
"attempt_timestamp",
"event"
]
@@ -10238,11 +10237,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -10306,11 +10305,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -10380,16 +10379,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -10412,11 +10411,11 @@
},
"code": {
"type": "string",
- "const": "not_found.delivery"
+ "const": "delivery_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Delivery not found"
+ "const": "Webhook delivery not found"
},
"description": {
"type": "string"
@@ -10483,8 +10482,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -10511,7 +10510,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -10579,7 +10578,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -10602,11 +10601,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -10673,8 +10672,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -10952,11 +10951,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -11020,11 +11019,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -11094,16 +11093,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -11126,11 +11125,11 @@
},
"code": {
"type": "string",
- "const": "not_found.delivery"
+ "const": "delivery_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Delivery not found"
+ "const": "Webhook delivery not found"
},
"description": {
"type": "string"
@@ -11197,8 +11196,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -11225,7 +11224,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -11293,7 +11292,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -11316,11 +11315,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -11387,8 +11386,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -11632,24 +11631,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -11851,11 +11843,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -11919,11 +11911,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -11993,16 +11985,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -12029,7 +12021,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -12097,7 +12089,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -12120,11 +12112,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -12191,8 +12183,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -12412,24 +12404,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -12576,11 +12561,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -12644,11 +12629,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -12718,16 +12703,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -12754,7 +12739,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -12822,7 +12807,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -12845,11 +12830,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -12916,8 +12901,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -13108,24 +13093,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"signing_secret": {
@@ -13262,24 +13240,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -13427,11 +13398,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -13495,11 +13466,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -13569,16 +13540,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -13605,7 +13576,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -13673,7 +13644,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -13696,11 +13667,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -13767,8 +13738,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -14001,24 +13972,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -14165,11 +14129,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -14233,11 +14197,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -14307,16 +14271,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -14339,11 +14303,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -14410,8 +14374,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -14438,7 +14402,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -14506,7 +14470,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -14529,11 +14493,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -14600,8 +14564,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -14832,24 +14796,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -14996,11 +14953,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -15064,11 +15021,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -15138,16 +15095,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -15170,11 +15127,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -15241,8 +15198,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -15269,7 +15226,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -15337,7 +15294,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -15360,11 +15317,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -15431,8 +15388,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -15622,24 +15579,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"signing_secret": {
@@ -15784,24 +15734,17 @@
]
},
"custom_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string",
- "pattern": "^[a-zA-Z0-9-]+$"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
"description": "Additional request headers to pass when performing HTTP request location defined by `url`. Both keys and values must be strings and a valid HTTP headers.",
"example": {
"Authorization": "Bearer example_token"
+ },
+ "type": "object",
+ "propertyNames": {
+ "type": "string",
+ "pattern": "^[a-zA-Z0-9-]+$"
+ },
+ "additionalProperties": {
+ "type": "string"
}
},
"created_by": {
@@ -15948,11 +15891,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -16016,11 +15959,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -16090,16 +16033,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -16122,11 +16065,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -16193,8 +16136,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -16221,7 +16164,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -16289,7 +16232,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -16312,11 +16255,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -16383,8 +16326,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -16601,20 +16544,13 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -16642,11 +16578,97 @@
}
]
},
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "error_message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
"description": "Timestamp of the attempt."
+ },
+ "event": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "v1.project.paused",
+ "v1.project.created",
+ "v1.project.restored",
+ "v1.project.transferred",
+ "v1.project.removed",
+ "v1.project.restarted",
+ "v1.project.status.changed",
+ "v1.project.backup.started",
+ "v1.project.branch.created",
+ "v1.project.branch.updated",
+ "v1.project.branch.removed",
+ "v1.organization.member.invitation.created",
+ "v1.organization.member.invitation.canceled",
+ "v1.organization.member.added",
+ "v1.organization.member.removed",
+ "v1.organization.member.role.assigned",
+ "v1.organization.member.role.removed",
+ "v1.organization.member.role.updated",
+ "v1.organization.billing.plan.upgraded",
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
+ },
+ "payload": {
+ "type": "object",
+ "properties": {
+ "organization_slug": {
+ "type": "string",
+ "pattern": "^[\\w-]+$",
+ "description": "Organization slug",
+ "example": "tsrqponmlkjihgfedcba"
+ },
+ "project_ref": {
+ "anyOf": [
+ {
+ "type": "string",
+ "minLength": 20,
+ "maxLength": 20,
+ "pattern": "^[a-z]+$",
+ "description": "Project ref",
+ "example": "abcdefghijklmnopqrst"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "required": ["organization_slug", "project_ref"],
+ "description": "Final data sent to the consumer."
+ },
+ "timestamp": {
+ "type": "string",
+ "format": "date-time",
+ "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
+ "description": "Timestamp of event publication."
+ }
+ },
+ "required": ["type", "payload", "timestamp"]
}
},
"required": [
@@ -16656,7 +16678,10 @@
"response_code",
"response_headers",
"response_body",
- "attempt_timestamp"
+ "error_code",
+ "error_message",
+ "attempt_timestamp",
+ "event"
]
}
},
@@ -16835,11 +16860,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -16903,11 +16928,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -16977,16 +17002,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -17009,11 +17034,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -17080,8 +17105,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -17108,7 +17133,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -17176,7 +17201,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -17199,11 +17224,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -17270,8 +17295,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -17452,11 +17477,11 @@
},
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.disabled"
+ "const": "endpoint_disabled"
},
"message": {
"type": "string",
- "const": "Bad Request: Endpoint is disabled"
+ "const": "Webhook endpoint is disabled"
},
"description": {
"type": "string"
@@ -17520,11 +17545,11 @@
},
"code": {
"type": "string",
- "const": "bad_request.endpoint.test.wrong_event_type"
+ "const": "endpoint_event_type_not_subscribed"
},
"message": {
"type": "string",
- "const": "Bad Request: Provided event type is not subscribed to by the endpoint"
+ "const": "Webhook endpoint is not subscribed to this event type"
},
"description": {
"type": "string"
@@ -17594,18 +17619,18 @@
"EndpointTestDisabled": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.disabled",
- "message": "Bad Request: Endpoint is disabled",
- "description": "Endpoint is disabled, to send test event endpoint must first be enabled."
+ "code": "endpoint_disabled",
+ "description": "Endpoint is disabled, to send test event endpoint must first be enabled.",
+ "message": "Webhook endpoint is disabled"
}
}
},
"EndpointTestWrongEventType": {
"value": {
"error": {
- "code": "bad_request.endpoint.test.wrong_event_type",
- "message": "Bad Request: Provided event type is not subscribed to by the endpoint",
- "description": "Only event types that the endpoint is subscribed to can be specified."
+ "code": "endpoint_event_type_not_subscribed",
+ "description": "Only event types that the endpoint is subscribed to can be specified.",
+ "message": "Webhook endpoint is not subscribed to this event type"
}
}
}
@@ -17725,11 +17750,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -17793,11 +17818,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -17867,16 +17892,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -17899,11 +17924,11 @@
},
"code": {
"type": "string",
- "const": "not_found.endpoint"
+ "const": "endpoint_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Endpoint not found"
+ "const": "Webhook endpoint not found"
},
"description": {
"type": "string"
@@ -17970,8 +17995,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.endpoint",
- "message": "Not Found: Endpoint not found"
+ "code": "endpoint_not_found",
+ "message": "Webhook endpoint not found"
}
}
}
@@ -17998,7 +18023,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -18066,7 +18091,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -18089,11 +18114,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -18160,8 +18185,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -18286,7 +18311,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -18308,29 +18332,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
}
},
"required": ["type"]
@@ -18422,20 +18426,13 @@
"description": "HTTP status code of the response, `0` if unavailable."
},
"response_headers": {
- "anyOf": [
- {
- "type": "object",
- "propertyNames": {
- "type": "string"
- },
- "additionalProperties": {
- "type": "string"
- }
- },
- {
- "type": "null"
- }
- ],
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {
+ "type": "string"
+ },
"description": "HTTP headers of the response, `{}` if unavailable."
},
"response_body": {
@@ -18463,6 +18460,26 @@
}
]
},
+ "error_code": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "error_message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"attempt_timestamp": {
"type": "string",
"format": "date-time",
@@ -18473,7 +18490,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Webhook event type.",
"type": "string",
"enum": [
"v1.project.paused",
@@ -18495,29 +18511,9 @@
"v1.organization.member.role.removed",
"v1.organization.member.role.updated",
"v1.organization.billing.plan.upgraded",
- "v1.organization.billing.plan.downgraded",
- "project.v1.paused",
- "project.v1.created",
- "project.v1.restored",
- "project.v1.transferred",
- "project.v1.removed",
- "project.v1.restarted",
- "project.v1.status.changed",
- "project.v1.backup.started",
- "project.v1.branch.created",
- "project.v1.branch.updated",
- "project.v1.branch.removed",
- "organization.v1.member.invitation.created",
- "organization.v1.member.invitation.canceled",
- "organization.v1.member.added",
- "organization.v1.member.removed",
- "organization.v1.member.role.assigned",
- "organization.v1.member.role.removed",
- "organization.v1.member.role.updated",
- "organization.v1.billing.plan.upgraded",
- "organization.v1.billing.plan.downgraded",
- "project.v1.branch.deleted"
- ]
+ "v1.organization.billing.plan.downgraded"
+ ],
+ "description": "Webhook event type."
},
"payload": {
"type": "object",
@@ -18564,6 +18560,8 @@
"response_code",
"response_headers",
"response_body",
+ "error_code",
+ "error_message",
"attempt_timestamp",
"event"
]
@@ -18689,11 +18687,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -18757,11 +18755,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -18831,16 +18829,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -18863,11 +18861,11 @@
},
"code": {
"type": "string",
- "const": "not_found.delivery"
+ "const": "delivery_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Delivery not found"
+ "const": "Webhook delivery not found"
},
"description": {
"type": "string"
@@ -18934,8 +18932,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -18962,7 +18960,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -19030,7 +19028,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -19053,11 +19051,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -19124,8 +19122,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -19401,11 +19399,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.permission_denied"
+ "const": "forbidden"
},
"message": {
"type": "string",
- "const": "Forbidden: Permission denied"
+ "const": "Forbidden"
},
"description": {
"type": "string"
@@ -19469,11 +19467,11 @@
},
"code": {
"type": "string",
- "const": "forbidden.access_disabled"
+ "const": "webhooks_access_disabled"
},
"message": {
"type": "string",
- "const": "Forbidden: Access disabled"
+ "const": "Webhooks access is disabled for this organization or project"
},
"description": {
"type": "string"
@@ -19543,16 +19541,16 @@
"PermissionDenied": {
"value": {
"error": {
- "code": "forbidden.permission_denied",
- "message": "Forbidden: Permission denied"
+ "code": "forbidden",
+ "message": "Forbidden"
}
}
},
"AccessDisabled": {
"value": {
"error": {
- "code": "forbidden.access_disabled",
- "message": "Forbidden: Access disabled"
+ "code": "webhooks_access_disabled",
+ "message": "Webhooks access is disabled for this organization or project"
}
}
}
@@ -19575,11 +19573,11 @@
},
"code": {
"type": "string",
- "const": "not_found.delivery"
+ "const": "delivery_not_found"
},
"message": {
"type": "string",
- "const": "Not Found: Delivery not found"
+ "const": "Webhook delivery not found"
},
"description": {
"type": "string"
@@ -19646,8 +19644,8 @@
"Default example": {
"value": {
"error": {
- "code": "not_found.delivery",
- "message": "Not Found: Delivery not found"
+ "code": "delivery_not_found",
+ "message": "Webhook delivery not found"
}
}
}
@@ -19674,7 +19672,7 @@
},
"message": {
"type": "string",
- "const": "Request Timeout"
+ "const": "Request timed out"
},
"description": {
"type": "string"
@@ -19742,7 +19740,7 @@
"value": {
"error": {
"code": "request_timeout",
- "message": "Request Timeout"
+ "message": "Request timed out"
}
}
}
@@ -19765,11 +19763,11 @@
},
"code": {
"type": "string",
- "const": "too_many_requests"
+ "const": "rate_limit_exceeded"
},
"message": {
"type": "string",
- "const": "Too Many Requests"
+ "const": "Rate limit exceeded"
},
"description": {
"type": "string"
@@ -19836,8 +19834,8 @@
"Default example": {
"value": {
"error": {
- "code": "too_many_requests",
- "message": "Too Many Requests"
+ "code": "rate_limit_exceeded",
+ "message": "Rate limit exceeded"
}
}
}
@@ -20194,7 +20192,49 @@
"type": "string"
},
"code": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
},
"message": {
"type": "string"
@@ -20237,7 +20277,54 @@
"issues": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ErrorResponseBodyAPIErrorObject"
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "rel": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
+ "type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "additionalProperties": {}
+ }
+ },
+ "required": ["code", "message"]
}
}
},
@@ -21441,6 +21528,14 @@
"logical_decoding_work_mem": {
"type": "string"
},
+ "autovacuum_max_workers": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 262143
+ },
+ "autovacuum_work_mem": {
+ "type": "string"
+ },
"log_autovacuum_min_duration": {
"type": "string",
"description": "Default unit: ms",
@@ -21579,6 +21674,16 @@
},
"cron_log_statement": {
"type": "boolean"
+ },
+ "pg_net_batch_size": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 32767
+ },
+ "pg_stat_statements_max": {
+ "type": "integer",
+ "minimum": 100,
+ "maximum": 45000
}
},
"description": "Postgres parameter overrides. Empty when the project runs entirely on defaults."
@@ -23770,7 +23875,49 @@
"type": "string"
},
"code": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
},
"message": {
"type": "string"
@@ -24319,7 +24466,49 @@
"type": "string"
},
"code": {
- "type": "string"
+ "type": "string",
+ "enum": [
+ "bad_request",
+ "forbidden",
+ "internal_server_error",
+ "not_found",
+ "payment_required",
+ "rate_limit_exceeded",
+ "request_timeout",
+ "request_too_large",
+ "unauthorized",
+ "validation_failed",
+ "agentic_credential_not_found",
+ "branch_admin_required",
+ "compute_build_context_too_large",
+ "compute_build_in_progress",
+ "compute_deploy_rate_limit_exceeded",
+ "compute_instance_limit_exceeded",
+ "compute_instance_not_found",
+ "compute_not_enabled",
+ "compute_request_rejected",
+ "compute_unavailable",
+ "notebook_cell_duplicate",
+ "notebook_cell_unknown",
+ "notebook_disabled",
+ "notebook_not_found",
+ "notebook_sort_invalid",
+ "organization_invitation_email_delivery_failed",
+ "organization_invitations_partially_failed",
+ "organization_role_name_invalid",
+ "organization_role_not_entitled",
+ "pagination_cursor_invalid",
+ "project_branch_resync_unsupported",
+ "project_not_found",
+ "project_privatelink_disabled",
+ "project_transfer_disabled",
+ "delivery_not_found",
+ "endpoint_disabled",
+ "endpoint_event_type_not_subscribed",
+ "endpoint_not_found",
+ "endpoint_url_unresolvable",
+ "webhooks_access_disabled"
+ ]
},
"message": {
"type": "string"
@@ -24371,7 +24560,63 @@
"issues": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/APIErrorObject"
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "links": {
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "href": {
+ "type": "string"
+ },
+ "rel": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "describedby": {
+ "type": "string"
+ },
+ "meta": {
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {}
+ }
+ },
+ "required": ["href"]
+ }
+ },
+ "meta": {
+ "type": "object",
+ "propertyNames": {
+ "type": "string"
+ },
+ "additionalProperties": {}
+ }
+ },
+ "required": ["code", "message"]
}
}
},