Skip to content
API Reference
/
/
Update a webhook

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

Custom Properties

API for managing custom properties

Operations

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations

List all webhooks

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks?page=string&per_page=string' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(Webhook)required
data[].​idstring(WebhookId)^we_required

Webhook Identifier

data[].​urlstringrequired
data[].​tokenstringrequired
data[].​descriptionstring or nullrequired
Any of:
string
data[].​created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​last_used_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
data[].​subscribed_eventsArray of stringsrequired
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a new webhook

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
urlstringrequired
descriptionstring
subscribed_eventsArray of strings
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/webhooks \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "url": "string",
    "description": "string",
    "subscribed_events": [
      "employee.created"
    ]
  }'

Responses

Webhook

Bodyapplication/json
idstring(WebhookId)^we_required

Webhook Identifier

urlstringrequired
tokenstringrequired
descriptionstring or nullrequired
Any of:
string
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

last_used_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
subscribed_eventsArray of stringsrequired
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
Response
application/json
{
  "id": "we_abc123def456",
  "url": "string",
  "token": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "last_used_at": "string",
  "subscribed_events": [
    "employee.created"
  ]
}

Get a webhook by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
webhook_idstring(WebhookId)^we_required

Webhook Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks/{webhook_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

Webhook

Bodyapplication/json
idstring(WebhookId)^we_required

Webhook Identifier

urlstringrequired
tokenstringrequired
descriptionstring or nullrequired
Any of:
string
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

last_used_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
subscribed_eventsArray of stringsrequired
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
Response
application/json
{
  "id": "we_abc123def456",
  "url": "string",
  "token": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "last_used_at": "string",
  "subscribed_events": [
    "employee.created"
  ]
}

Update a webhook

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
webhook_idstring(WebhookId)^we_required

Webhook Identifier

Bodyapplication/jsonrequired
descriptionstring
subscribed_eventsArray of strings
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks/{webhook_id}' \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "description": "string",
    "subscribed_events": [
      "employee.created"
    ]
  }'

Responses

Webhook

Bodyapplication/json
idstring(WebhookId)^we_required

Webhook Identifier

urlstringrequired
tokenstringrequired
descriptionstring or nullrequired
Any of:
string
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

last_used_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
subscribed_eventsArray of stringsrequired
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
Response
application/json
{
  "id": "we_abc123def456",
  "url": "string",
  "token": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "last_used_at": "string",
  "subscribed_events": [
    "employee.created"
  ]
}

Delete a webhook

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
webhook_idstring(WebhookId)^we_required

Webhook Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks/{webhook_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

Webhook

Bodyapplication/json
idstring(WebhookId)^we_required

Webhook Identifier

urlstringrequired
tokenstringrequired
descriptionstring or nullrequired
Any of:
string
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

last_used_atDateTimeUtc (string) or nullrequired
Any of:

a string to be decoded into a DateTime.Utc

string(DateTimeUtc)
subscribed_eventsArray of stringsrequired
Items Enum"employee.created""employee.updated""employee.deleted""employer.created""employer.updated""employer.deleted""client.created""client.updated""client.deleted""job.created"
Response
application/json
{
  "id": "we_abc123def456",
  "url": "string",
  "token": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "last_used_at": "string",
  "subscribed_events": [
    "employee.created"
  ]
}