> ## Documentation Index > Fetch the complete documentation index at: https://checkfu.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create a managed provider webhook registration > Mint a ProviderWebhookRegistration for one Automation WebhookSource: persist the desired config and fingerprint, place the verification secret in CredentialCustody, claim the external create, call the provider adapter, and adopt only an exact callback key plus config fingerprint. Secrets never appear in the registration or this response. Accepts an optional Idempotency-Key. Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. ## OpenAPI ````yaml /openapi.json post /v1/automations/{id}/provider-webhook-registrations openapi: 3.1.0 info: title: Checkfu API version: '2026-08-27' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-27); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnesses - name: harnessRuntime - name: sandboxProfiles - name: computerProfiles - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: dreams - name: modelCredentials - name: modelRoutingProfiles - name: blueprintInstallations - name: toolSources - name: skills - name: skillSources - name: agentSources - name: skillProposals - name: instructionProposals - name: catalog - name: concepts - name: support - name: connections - name: connectionVaults - name: connectionAssignments - name: connectedRuntimes - name: projects - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: usage - name: models - name: outcomes - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: webhookEndpoints - name: integrationGateway - name: agentDeployments - name: workEnvironments - name: computers - name: computerScreens - name: computerBrowserObservations - name: computerBrowserActions - name: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/automations/{id}/provider-webhook-registrations: post: tags: - automations summary: Create a managed provider webhook registration description: >- Mint a ProviderWebhookRegistration for one Automation WebhookSource: persist the desired config and fingerprint, place the verification secret in CredentialCustody, claim the external create, call the provider adapter, and adopt only an exact callback key plus config fingerprint. Secrets never appear in the registration or this response. Accepts an optional Idempotency-Key. Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: automations.createProviderWebhookRegistration parameters: - name: id in: path schema: $ref: '#/components/schemas/AutomationId' required: true - name: checkfu-version in: header schema: type: string enum: - '2026-08-27' required: true - name: idempotency-key in: header schema: type: string allOf: - maxLength: 255 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProviderWebhookRegistration' required: true responses: '201': description: >- Closed provider-side webhook lifecycle and health for one Automation and WebhookSource. Secrets never appear. content: application/json: schema: $ref: '#/components/schemas/ProviderWebhookRegistration' headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: $ref: '#/components/schemas/ValidationMalformedError' '401': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object required: - error properties: error: type: object properties: type: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '404': description: >- The requested resource does not exist in the resolved deployment boundary. content: application/json: schema: $ref: '#/components/schemas/ValidationNotFoundError' '409': description: >- The request conflicts with the resource's current state. | An idempotent mutation conflicts with a completed or in-progress request for the same key. content: application/json: schema: anyOf: - $ref: '#/components/schemas/ValidationConflictError' - $ref: '#/components/schemas/IdempotencyConflictError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' security: - bearerAuth: [] components: schemas: AutomationId: type: string allOf: - pattern: ^auto_[0-9a-f]{32}$ CreateProviderWebhookRegistration: type: object properties: webhook_source_id: $ref: '#/components/schemas/WebhookSourceId' connection_id: $ref: '#/components/schemas/ConnectionId' config: $ref: '#/components/schemas/ProviderWebhookConfig' required: - webhook_source_id - connection_id - config additionalProperties: false ProviderWebhookRegistration: type: object properties: id: $ref: '#/components/schemas/ProviderWebhookRegistrationId' workspace_id: $ref: '#/components/schemas/WorkspaceId' automation_id: $ref: '#/components/schemas/AutomationId' webhook_source_id: $ref: '#/components/schemas/WebhookSourceId' connection_id: $ref: '#/components/schemas/ConnectionId' callback_key: $ref: '#/components/schemas/ProviderWebhookCallbackKey' config: $ref: '#/components/schemas/ProviderWebhookConfig' config_fingerprint: type: string allOf: - pattern: ^sha256:[0-9a-f]{64}$ status: $ref: '#/components/schemas/ProviderWebhookRegistrationStatus' external_id: anyOf: - type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ - type: 'null' claim: $ref: '#/components/schemas/Union_273' last_verified_at: anyOf: - $ref: '#/components/schemas/CurrentTimestamp' - type: 'null' last_delivery_at: anyOf: - $ref: '#/components/schemas/CurrentTimestamp' - type: 'null' last_error: $ref: '#/components/schemas/Union_274' version: type: integer allOf: - exclusiveMinimum: 0 created_at: $ref: '#/components/schemas/CurrentTimestamp' updated_at: $ref: '#/components/schemas/CurrentTimestamp' required: - id - workspace_id - automation_id - webhook_source_id - connection_id - callback_key - config - config_fingerprint - status - external_id - claim - last_verified_at - last_delivery_at - last_error - version - created_at - updated_at additionalProperties: false description: >- Closed provider-side webhook lifecycle and health for one Automation and WebhookSource. Secrets never appear. WorkspaceId: type: string allOf: - pattern: ^wrkspc_[0-9a-f]{32}$ ValidationMalformedError: type: object properties: error: type: object properties: type: type: string enum: - validation.malformed message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-malformed description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- The request could not be decoded or violated a declared input constraint. PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - policy.denied message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Deployment governance or retention policy denied the request. ValidationNotFoundError: type: object properties: error: type: object properties: type: type: string enum: - validation.not_found message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-not-found description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- The requested resource does not exist in the resolved deployment boundary. ValidationConflictError: type: object properties: error: type: object properties: type: type: string enum: - validation.conflict message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#validation-conflict description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The request conflicts with the resource's current state. IdempotencyConflictError: anyOf: - $ref: '#/components/schemas/ValidationIdempotencyConflictError' - $ref: '#/components/schemas/ValidationIdempotencyInProgressError' description: >- An idempotent mutation conflicts with a completed or in-progress request for the same key. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - runtime.internal message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. WebhookSourceId: type: string allOf: - pattern: ^whsrc_[0-9a-f]{32}$ ConnectionId: type: string allOf: - pattern: ^conn_[0-9a-f]{32}$ ProviderWebhookConfig: type: object properties: provider: $ref: '#/components/schemas/ProviderWebhookProvider' resource: $ref: '#/components/schemas/Objects_149' event_types: type: array items: type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ allOf: - minItems: 1 - maxItems: 32 required: - provider - resource - event_types additionalProperties: false ProviderWebhookRegistrationId: type: string allOf: - pattern: ^pwreg_[0-9a-f]{32}$ ProviderWebhookCallbackKey: type: string allOf: - pattern: ^pwcbk_[0-9a-f]{32}$ ProviderWebhookRegistrationStatus: type: string enum: - pending - active - degraded - indeterminate - revoked - deleted Union_273: anyOf: - $ref: '#/components/schemas/ProviderWebhookExternalClaim' - type: 'null' CurrentTimestamp: type: string allOf: - maxLength: 24 - pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ description: A canonical UTC ISO-8601 timestamp with millisecond precision. Union_274: anyOf: - $ref: '#/components/schemas/ProviderWebhookHealthError' - type: 'null' ValidationIdempotencyConflictError: type: object properties: error: type: object properties: type: type: string enum: - validation.idempotency_conflict message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-idempotency-conflict description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: The Idempotency-Key is already bound to a different request. ValidationIdempotencyInProgressError: type: object properties: error: type: object properties: type: type: string enum: - validation.idempotency_in_progress message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-idempotency-in-progress description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- An identical idempotent request is still in progress and may be retried later. ProviderWebhookProvider: type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ Objects_149: type: object properties: resource_type: type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ external_id: type: string allOf: - minLength: 1 - maxLength: 512 required: - resource_type - external_id additionalProperties: false ProviderWebhookExternalClaim: type: object properties: epoch: type: integer allOf: - minimum: 0 operation: type: string enum: - create - update - delete callback_key: $ref: '#/components/schemas/ProviderWebhookCallbackKey' config_fingerprint: type: string allOf: - pattern: ^sha256:[0-9a-f]{64}$ expires_at: $ref: '#/components/schemas/CurrentTimestamp' required: - epoch - operation - callback_key - config_fingerprint - expires_at additionalProperties: false ProviderWebhookHealthError: type: object properties: code: type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ at: $ref: '#/components/schemas/CurrentTimestamp' required: - code - at additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer ````