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/get-on-board-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: Get on Board Webhooks API
version: 0.1.0
description: The Get on Board API provides access to the data inside Get on Board, the leading recruitment platform for tech professionals in Latin America.
servers:
- url: https://www.getonbrd.com
description: Production
- url: https://sandbox.getonbrd.dev
description: Sandbox
tags:
- name: Webhooks
description: Webhook endpoints and events
paths:
/api/v0/webhook_endpoints:
get:
summary: List webhook endpoints
tags:
- Webhooks
security:
- BearerAuth: []
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
responses:
'200':
description: Returns all webhook endpoints for the authenticated subscriber.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
endpoint:
type: string
state:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- state
- events
required:
- id
- type
- attributes
required:
- data
example:
data:
- id: '1'
type: webhook_endpoint
attributes:
endpoint: https://hooks.example.com/b
state: active
events:
- job.match
- id: '1'
type: webhook_endpoint
attributes:
endpoint: https://hooks.example.com/a
state: active
events:
- job.match
'401':
description: Returns all webhook endpoints for the authenticated subscriber.
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
example:
message: (Status 401) Unauthorized access.
code: unauthorized
operationId: listWebhookEndpoints
post:
summary: Create a webhook endpoint
tags:
- Webhooks
security:
- BearerAuth: []
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
endpoint:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- events
example:
endpoint: https://hooks.example.com/a
events:
- job.match
- job.match
responses:
'200':
description: Creates a new webhook endpoint with the specified events.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
endpoint:
type: string
state:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- state
- events
required:
- id
- type
- attributes
required:
- data
example:
data:
id: 7032348ebd4ec817921d4bf3ef130499
type: webhook_endpoint
attributes:
endpoint: https://hooks.example.com/a
state: active
events:
- job.match
'422':
description: Creates a new webhook endpoint with the specified events.
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
events:
type: array
items:
type: string
required:
- events
code:
type: string
required:
- message
- code
example:
message:
events:
- Contains one or more events that are not allowed.
code: unprocessable_content
operationId: createWebhookEndpoint
description: 'Webhook setup flow: list valid events with `GET /api/v0/webhook_events`, create an endpoint with an HTTPS `endpoint` URL and selected `events`, then use `GET /api/v0/webhook_endpoints` to confirm the saved subscription.'
/api/v0/webhook_endpoints/{id}:
delete:
summary: Delete a webhook endpoint
tags:
- Webhooks
security:
- BearerAuth: []
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
- name: id
in: path
required: true
schema:
type: string
example: fed4500fec17ca1bf5060625cb11be67
description: Webhook endpoint slug from `GET /api/v0/webhook_endpoints`.
responses:
'200':
description: Deletes an existing webhook endpoint by its slug.
content:
application/json:
schema:
type: object
properties:
status:
type: string
required:
- status
example:
status: ok
'404':
description: Deletes an existing webhook endpoint by its slug.
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
example:
message: Record not found
code: not_found
operationId: deleteWebhookEndpoint
get:
summary: Retrieve a webhook endpoint
tags:
- Webhooks
security:
- BearerAuth: []
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
- name: id
in: path
required: true
schema:
type: string
example: 08a3ea6669208832909e2022a073ceb9
description: Webhook endpoint slug from `GET /api/v0/webhook_endpoints`.
responses:
'200':
description: Returns the details of a specific webhook endpoint by its slug.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
endpoint:
type: string
state:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- state
- events
required:
- id
- type
- attributes
required:
- data
example:
data:
id: 9c4e1d2c4f84eab38a650f94b2dec2a8
type: webhook_endpoint
attributes:
endpoint: https://hooks.example.com/owned
state: active
events:
- job.match
'404':
description: Returns the details of a specific webhook endpoint by its slug.
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
example:
message: Record not found
code: not_found
operationId: retrieveWebhookEndpoint
put:
summary: Update a webhook endpoint
tags:
- Webhooks
security:
- BearerAuth: []
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
- name: id
in: path
required: true
schema:
type: string
example: a3a9bca58d8d4f0c6c7dba65594bde95
description: Webhook endpoint slug from `GET /api/v0/webhook_endpoints`.
responses:
'200':
description: Updates an existing webhook endpoint's events or configuration.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
endpoint:
type: string
state:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- state
- events
required:
- id
- type
- attributes
required:
- data
example:
data:
id: 44bdd0c04e3a7cf0379403ba037fb14f
type: webhook_endpoint
attributes:
endpoint: https://hooks.example.com/updated
state: active
events:
- job.match
'422':
description: Updates an existing webhook endpoint's events or configuration.
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
events:
type: array
items:
type: string
required:
- events
code:
type: string
required:
- message
- code
example:
message:
events:
- Contains one or more events that are not allowed.
code: unprocessable_content
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
endpoint:
type: string
events:
type: array
items:
type: string
required:
- endpoint
- events
example:
endpoint: https://hooks.example.com/updated
events:
- job.match
operationId: updateWebhookEndpoint
/api/v0/webhook_events:
get:
summary: List webhook events
tags:
- Webhooks
security:
- BearerAuth: []
responses:
'200':
description: Returns the available webhook event types for the authenticated subscriber.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
attributes:
type: object
properties:
label:
type: string
description:
type: string
required:
- label
- description
required:
- id
- type
- attributes
required:
- data
example:
data:
- id: '1'
type: webhook_event
attributes:
label: Job matching your preferences
description: A new job matching your preferences has been published
'401':
description: Returns the available webhook event types for the authenticated subscriber.
content:
application/json:
schema:
type: object
properties:
message:
type: string
code:
type: string
required:
- message
- code
example:
message: (Status 401) Unauthorized access to webhooks events
code: unauthorized
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
example: Bearer YOUR_JWT_TOKEN
description: Bearer credential for the authentication scheme required by this endpoint.
operationId: listWebhookEvents
description: Call this before creating or updating webhook endpoints. Send only event IDs returned by this endpoint in the `events` array.
components:
securitySchemes:
ApiKeyAuth:
type: http
scheme: bearer
bearerFormat: API key
description: 'Company authentication for private endpoints. Send `Authorization: Bearer <api_key>`.'
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Professional JWT token obtained via /api/v0/auth_tokens
BoardSecretKey:
type: http
scheme: bearer
bearerFormat: Board secret
description: 'Board+ HMAC secret key. Send `Authorization: Bearer <board_secret_key>`. The legacy query-string form (`?secret_key=...`) is still accepted by the server but is discouraged because secrets leak into logs, browser history, and referrers.'
x-tagGroups:
- name: Public
tags:
- Categories
- Companies
- Countries
- Headcounts
- Industries
- Insights
- Modalities
- Perks
- Regions
- Search
- Seniorities
- Tags
- Tenant Cities
- name: Private
tags:
- Applications
- Company shells
- Jobs
- Matching
- Processes
- Professionals
- Webhooks
- name: Authentication
tags:
- Authentication
- name: Board+
tags:
- Board+