Skip to content
API Reference
/
/
Update a webhook

Update a webhook

Request

Security
form_session or user_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 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>' \
  -H 'Content-Type: application/json' \
  -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
{
  "id": "we_abc123def456",
  "url": "string",
  "token": "string",
  "description": "string",
  "created_at": "string",
  "updated_at": "string",
  "last_used_at": "string",
  "subscribed_events": [
    "employee.created"
  ]
}