Skip to content
/Webhooks

Onboarded API (0.0.1)

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

Components

Components APIs

Operations

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

Jobs

Jobs APIs

Operations

Placements

Placements APIs

Operations

Tasks

Tasks APIs

Operations

Task Change Requests

Task Change Requests APIs

Operations

Forms

Forms APIs

Operations

Files

Files APIs

Operations

Themes

Themes APIs

Operations

Custom Properties

Custom Properties APIs

Operations

Users

Users APIs

Operations

Webhooks

Webhooks APIs

Operations

List all webhooks

Request

Security
bearerAuth
Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks?page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​urlstringrequired
data[].​descriptionstring or nullrequired
data[].​tokenstringrequired
data[].​created_atstring(date-time)required
data[].​updated_atstring(date-time)required
data[].​last_used_atstring or null(date-time)required
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
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create a webhook

Request

Security
bearerAuth
Bodyapplication/json

Body

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 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "string",
    "description": "string",
    "subscribed_events": [
      "employee.created"
    ]
  }'

Responses

201

Bodyapplication/json
idstringrequired
urlstringrequired
descriptionstring or nullrequired
tokenstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
last_used_atstring or null(date-time)required
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": "string",
  "url": "string",
  "description": "string",
  "token": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z",
  "subscribed_events": [
    "employee.created"
  ]
}

Get a webhook by id

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
urlstringrequired
descriptionstring or nullrequired
tokenstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
last_used_atstring or null(date-time)required
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": "string",
  "url": "string",
  "description": "string",
  "token": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z",
  "subscribed_events": [
    "employee.created"
  ]
}

Update a webhook

Request

Security
bearerAuth
Path
idstringrequired
Bodyapplication/json

Body

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/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string",
    "subscribed_events": [
      "employee.created"
    ]
  }'

Responses

200

Bodyapplication/json
idstringrequired
urlstringrequired
descriptionstring or nullrequired
tokenstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
last_used_atstring or null(date-time)required
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": "string",
  "url": "string",
  "description": "string",
  "token": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z",
  "subscribed_events": [
    "employee.created"
  ]
}

Delete a webhook

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/webhooks/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
urlstringrequired
descriptionstring or nullrequired
tokenstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
last_used_atstring or null(date-time)required
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": "string",
  "url": "string",
  "description": "string",
  "token": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "last_used_at": "2019-08-24T14:15:22Z",
  "subscribed_events": [
    "employee.created"
  ]
}