Finalcad Webhooks API
The Webhooks API from Finalcad — 5 operation(s) for webhooks.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/finalcad-webhooks-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Finalcad One Webhooks API
version: '2.41'
summary: Webhook subscription management for the Finalcad One platform — list subscribable event codes, and create, read, update and delete hooks that POST to a client URL when an event fires.
description: Webhook subscription management for the Finalcad One platform — list subscribable event codes, and create, read, update and delete hooks that POST to a client URL when an event fires.
contact:
name: Finalcad One API — developer portal
url: https://developer.finalcad.com/
x-generated-by: API Evangelist enrichment pipeline (derived from the first-party Postman collection)
x-source: collections/finalcad.postman_collection.json
x-source-url: https://developer.finalcad.com/
servers:
- url: https://developer.finalcad.cloud/api
description: Production — the baseUrl variable published in the Finalcad One API Postman collection.
- url: https://developer.sandbox.finalcad.cloud/api
description: Sandbox — published by Finalcad in the 'Retrieve data in Power BI' tutorial of the same collection.
security:
- apiKey: []
tokenAuth: []
tags:
- name: Webhooks
paths:
/webhooks:
post:
operationId: createHook
summary: Create hook
description: 'Subscribe to a new webhook.
body mandatory info
Details
event
code of the event
business_organization_id
id of the organization
project_id
id of the project
client_url
url to be called then the hook occurs
body optionals info
client_token
client_header_key'
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
event: 100
business_organization_id: <uuid>
project_id: <uuid>
client_url: https://developer.sandbox.finalcad.cloud/api/webhooks/wait
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
hook_id: fe00b1a1-f604-481d-8b81-624f288e88c9
event: Meeting
business_organization_id: 2421734c-f191-4237-acd8-becf216eaae4
project_id: c75aafca-d318ac66-fa08-4613-8ce0-745e56917d9e
user_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
client_url: https://localhost:5001/api/response/99
is_enabled: true
created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
created_at: '2023-11-02T14:33:21.6122138Z'
updated_at: '2023-11-02T14:33:21.6122138Z'
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/webhooks/getevents:
get:
operationId: getEventsList
summary: Get events list
description: 'Get the list of all possible events.
A generic event automatically subscribes to all sub-events (those with the same hundreds digit).'
tags:
- Webhooks
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
events:
- code: 100
designation: Meeting
generic: 'yes'
- code: 104
designation: MeetingGeneration
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/webhooks/organization/{organizationId}:
get:
operationId: getHooksForTheOrganization
summary: Get hooks for the organization
description: 'Get the list of subscribed webhook events for a given organization.
Details
organization_id
id of the organization'
tags:
- Webhooks
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
description: Path variable `organizationId` as published in the collection.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
webhooks:
- hook_id: 140d8f4c-7eee-447b-a148-6f35db1f721e
event: Meeting
business_organization_id: 2421734c-f191-4237-acd8-becf216eaae4
project_id: 320625a3-7a1c31c9-b138-4d0e-aea8-ba610d2f997f
user_id: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
client_url: https://localhost:5001/api/response/50
is_enabled: true
created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
created_at: '2023-11-02T14:30:55.324Z'
updated_at: '2023-11-02T14:30:55.324Z'
- hook_id: 47277860-f814-4e25-b05f-948064281055
event: MeetingGeneration
business_organization_id: 2421734c-f191-4237-acd8-becf216eaae4
project_id: 320625a3-7a1c31c9-b138-4d0e-aea8-ba610d2f997f
user_id: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
client_url: https://localhost:5001/api/response/99
is_enabled: true
created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
created_at: '2023-11-02T14:30:55.258Z'
updated_at: '2023-11-02T14:30:55.258Z'
count: 2
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/webhooks/{hookId}:
get:
operationId: getHook
summary: Get hook
description: 'Get the details of a specific webhook.
Endpoint mandatory info
Details
hook_id
The ID of the hook'
tags:
- Webhooks
parameters:
- name: hookId
in: path
required: true
schema:
type: string
description: Path variable `hookId` as published in the collection.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
hook_id: 140d8f4c-7eee-447b-a148-6f35db1f721e
event: Meeting
business_organization_id: 2421734c-f191-4237-acd8-becf216eaae4
project_id: 320625a3-7a1c31c9-b138-4d0e-aea8-ba610d2f997f
user_id: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
client_url: https://localhost:5001/api/response/50
is_enabled: true
created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
created_at: '2023-11-02T14:30:55.324Z'
updated_at: '2023-11-02T14:30:55.324Z'
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/webhooks/{hook_id}:
delete:
operationId: deleteHook
summary: Delete hook
description: 'You can delete a subscription.
Details
hook_id
id of the hook'
tags:
- Webhooks
parameters:
- name: hook_id
in: path
required: true
schema:
type: string
description: Path variable `hook_id` as published in the collection.
responses:
'204':
description: No Content
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
put:
operationId: updateHook
summary: Update hook
description: 'You can update a subscription.
Details
hook_id
id of the hook
body params
same as hook creation'
tags:
- Webhooks
parameters:
- name: hook_id
in: path
required: true
schema:
type: string
description: Path variable `hook_id` as published in the collection.
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
client_url: https://localhost:5001/api/v1.0/webhooks/wait
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
hook_id: 140d8f4c-7eee-447b-a148-6f35db1f721e
event: Meeting
business_organization_id: 2421734c-f191-4237-acd8-becf216eaae4
project_id: 320625a3-7a1c31c9-b138-4d0e-aea8-ba610d2f997f
user_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
client_token: mon token
client_url: https://localhost:5001/api/response/50
is_enabled: true
created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a
created_at: '2023-11-02T14:30:55.324Z'
updated_at: '2023-11-02T14:30:55.324Z'
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
components:
schemas:
ApiError:
type: object
description: Finalcad One error envelope. `api_code` is either a static code (mostly 4xx, e.g. INVALID_INSTANCE_STATE) or a constructed code of the form {ProcessCode}_ERR{n} / {ProcessCode}_WRN{n} (mostly 5xx).
properties:
statut:
type: integer
description: HTTP status code, repeated in the body (spelled `statut`).
api_code:
type: string
description: Internal Finalcad API error code.
message:
type: string
description: Short explanation of the abnormality encountered.
data:
type: object
description: Complementary data to help understand the error.
additionalProperties: true
securitySchemes:
apiKey:
type: apiKey
in: header
name: X-API-Key
description: Organization API key issued by Finalcad to organizations on an Enterprise licence. Sent on every call.
tokenAuth:
type: apiKey
in: header
name: Authorization
description: '`Authorization: token <your_api_key>`, or `Authorization: bearer <user_token>` for the legacy user-token flow (POST /auth).'