> ## Documentation Index > Fetch the complete documentation index at: https://docs.join.tl/llms.txt > Use this file to discover all available pages before exploring further. # Create or renew a Zapier webhook subscription > Creates a 21-day Zapier-owned subscription. Target origins are allowlisted by Jointl. ## OpenAPI ````yaml /specs/openapi/jointl-api-v1.openapi.yaml post /api/v1/webhook-subscriptions openapi: 3.1.2 info: title: Jointl REST API and OAuth version: 1.0.0 summary: Supported public HTTP contract for Jointl third-party connections. description: >- HTTP contract for Jointl REST operations, OAuth, and Zapier subscription and action endpoints. Jointl does not provide a public sandbox. termsOfService: https://join.tl/legal/terms-of-service contact: name: Jointl Support url: https://join.tl servers: - url: https://api.join.tl description: Jointl production API security: [] tags: - name: OAuth description: OAuth 2.0 and OpenID Connect endpoints. - name: Discovery description: OAuth resource and issuer discovery. - name: Operations description: Permission-filtered read operations. - name: Actions description: Prepare, human approval, and confirmation. - name: Zapier description: Endpoints restricted to the approved Jointl Zapier app. paths: /api/v1/webhook-subscriptions: post: tags: - Zapier summary: Create or renew a Zapier webhook subscription description: >- Creates a 21-day Zapier-owned subscription. Target origins are allowlisted by Jointl. operationId: createZapierWebhookSubscription requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookSubscriptionRequest' example: eventType: check.created filters: flowId: flow_example_01 targetUrl: https://hooks.zapier.com/hooks/catch/example/example responses: '201': description: Subscription created or renewed. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/WebhookSubscription' requestId: type: string description: Request correlation identifier. required: - data - requestId additionalProperties: false '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '413': $ref: '#/components/responses/TooLarge' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' '503': $ref: '#/components/responses/Unavailable' security: - JointlOAuth: - workspace.read components: schemas: WebhookSubscriptionRequest: type: object properties: eventType: type: string enum: - check.created - check.status_changed - check.completed - verification.completed - verification.failed - public_profiles.completed - public_profiles.failed - reference.completed - employee.created - employee.updated - employee.status_changed - exit_intelligence.requested - exit_intelligence.completed - talent.created - talent.updated - talent.status_changed filters: type: object properties: companyId: type: string flowId: type: string additionalProperties: false targetUrl: type: string format: uri required: - eventType - targetUrl additionalProperties: false WebhookSubscription: type: object properties: id: type: string eventType: type: string filters: type: object additionalProperties: false createdAt: type: string format: date-time expiration_date: type: string format: date-time required: - id - eventType - filters - createdAt - expiration_date ErrorEnvelope: type: object properties: error: type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false requestId: type: string required: - error - requestId additionalProperties: false headers: RequestId: description: Request correlation identifier. schema: type: string RetryAfter: description: Seconds before retrying. schema: type: integer minimum: 1 responses: BadRequest: description: Invalid request. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: invalid-external-operation-input message: The operation input is invalid. requestId: request_example_400 Unauthorized: description: Authentication required. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not-authenticated message: Authentication is required. requestId: request_example_401 Forbidden: description: Insufficient scope or permission. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not-authorized message: You are not allowed to perform this action. requestId: request_example_403 NotFound: description: The operation or visible record was not found. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: not-found message: The requested record was not found. requestId: request_example_404 Conflict: description: State, replay, or idempotency conflict. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: external-action-conflict message: The action conflicts with current state. requestId: request_example_409 TooLarge: description: Request exceeds one MiB. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: request-too-large message: The request body is too large. requestId: request_example_413 RateLimited: description: Rate limit exceeded. headers: X-Request-Id: $ref: '#/components/headers/RequestId' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: too-many-requests message: Too many requests. requestId: request_example_429 ServerError: description: Server error. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: internal-error message: The request could not be completed. requestId: request_example_500 Unavailable: description: Temporarily unavailable or action outcome unknown. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: temporarily-unavailable message: The service is temporarily unavailable. requestId: request_example_503 securitySchemes: JointlOAuth: type: oauth2 description: OAuth access token issued for the REST resource. flows: authorizationCode: authorizationUrl: https://api.join.tl/oauth/authorize tokenUrl: https://api.join.tl/oauth/token refreshUrl: https://api.join.tl/oauth/token scopes: openid: Authenticate the Jointl member. email: Read the authorized member email claim. workspace.read: Read authorized Jointl workspace data. workspace.write: Prepare and confirm authorized Jointl changes. offline_access: Receive a rotating refresh token. x-jointl-resource: https://api.join.tl/api/v1 x-jointl-pkce-required: S256 ````