--- title: "Provider events" description: "Context4 provider event types and subscriptions: create and manage subscriptions through the public API." group: "Technical documentation" order: 36 --- ## Deployment addresses - Documentation: https://ctx4.me/docs.md - Agent index: https://ctx4.me/docs/agent-index.json - Console and connections: https://console.ctx4.me/integrations - MCP: https://ctx4.me/mcp - HTTP API: https://ctx4.me/v1 - Composio base URL: https://ctx4.me/compat/context4/v1 - OpenAPI: https://ctx4.me/docs/openapi.json - HTTP/MCP inventory: https://ctx4.me/docs/api-index.json - Composio routes: https://ctx4.me/docs/compat-routes.json - Connectors: https://ctx4.me/docs/connectors.json # Provider events Generated from the public Context4 OpenAPI. Authenticate with `Authorization: Bearer` and an API key. General rules: [API](https://ctx4.me/docs/api.md). Full contract: [OpenAPI JSON](https://ctx4.me/docs/openapi.json). In the JSON below, `$ref` points to a named schema in the Schemas section. ## listProviderEventTypes `GET /v1/provider-event-types` Deployment URL: `https://ctx4.me/v1/provider-event-types`. Replace parameters in braces with actual IDs from the API. List supported provider notification types and fields Capability: `events:read`. The contract defines no additional parameters. ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Provider event catalog | `application/json` {"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"connector_id":{"type":"string"},"entity":{"type":"string"},"event_types":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"field_types":{"type":"object","additionalProperties":{"type":"string","enum":["string","number","boolean"]}},"hydration_available":{"type":"boolean"}},"required":["connector_id","entity","event_types","fields","field_types","hydration_available"],"additionalProperties":false}}},"required":["data"],"additionalProperties":false} | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## subscribeProviderEvents `POST /v1/provider-event-subscriptions` Deployment URL: `https://ctx4.me/v1/provider-event-subscriptions`. Replace parameters in braces with actual IDs from the API. Subscribe to provider events without entity storage Capability: `events:write`. The contract defines no additional parameters. ### Request body Required. ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connection_id": { "type": "string", "format": "uuid", "example": "9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f" }, "event_types": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 160 }, "minItems": 1, "maxItems": 32 } }, "required": [ "connection_id", "event_types" ], "additionalProperties": false } } } } ``` ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Configured event subscription | `application/json` {"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connection_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"source_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connector_id":{"type":"string"},"event_types":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0},"enabled_at":{"type":"string","format":"date-time"},"payload_retention_seconds":{"type":"integer","exclusiveMinimum":0}},"required":["id","connection_id","source_id","connector_id","event_types","status","version","enabled_at","payload_retention_seconds"],"additionalProperties":false} | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## getProviderEventSubscription `GET /v1/provider-event-subscriptions` Deployment URL: `https://ctx4.me/v1/provider-event-subscriptions`. Replace parameters in braces with actual IDs from the API. Read the connection event subscription Capability: `events:read`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `connection_id` | query | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Subscription or null | `application/json` {"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connection_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"source_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connector_id":{"type":"string"},"event_types":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0},"enabled_at":{"type":"string","format":"date-time"},"payload_retention_seconds":{"type":"integer","exclusiveMinimum":0}},"required":["id","connection_id","source_id","connector_id","event_types","status","version","enabled_at","payload_retention_seconds"],"additionalProperties":false} | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ``` ## disableProviderEventSubscription `DELETE /v1/provider-event-subscriptions/{subscriptionId}` Deployment URL: `https://ctx4.me/v1/provider-event-subscriptions/{subscriptionId}`. Replace parameters in braces with actual IDs from the API. Disable a provider event subscription Capability: `events:write`. ### Parameters | Name | Location | Required | Type and constraints | | --- | --- | --- | --- | | `subscriptionId` | path | yes | {"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"} | ### Responses and errors | HTTP | Meaning | Format and schema | | --- | --- | --- | | 200 | Disabled subscription | `application/json` {"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connection_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"source_id":{"type":"string","format":"uuid","example":"9b2f6f2e-4b0a-4bd2-8b7e-3f8a1c2d4e5f"},"connector_id":{"type":"string"},"event_types":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0},"enabled_at":{"type":"string","format":"date-time"},"payload_retention_seconds":{"type":"integer","exclusiveMinimum":0}},"required":["id","connection_id","source_id","connector_id","event_types","status","version","enabled_at","payload_retention_seconds"],"additionalProperties":false} | | 400 | Problem (validation_failed) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 401 | Problem (authentication_required, invalid_api_key, api_key_expired, api_key_revoked) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 403 | Problem (capability_missing) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 404 | Problem (not_found) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 409 | Problem (conflict) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 429 | Problem (rate_limited) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 500 | Problem (internal) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | | 503 | Problem (service_unavailable) | `application/problem+json` [Problem](https://ctx4.me/docs/api-schemas-1.md#problem) | Successful response headers: ```json { "X-Request-Id": { "description": "Correlation id echoed on every response", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Per-key request limit for the current window", "schema": { "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the current window", "schema": { "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the current window resets", "schema": { "type": "integer" } } } ```