v1

latestOpenAPI 3.0.22026-07-24154101.1 MB

Webhooks

Create Webhook

post/v2/company/{company_id}/webhooks

Path parameters

company_idinteger required

Company ID

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

urlstring required

Webhook URL

method'post' required

Webhook Method

event'schedule.published' | 'time_punch.created' | 'time_punch.edited' | 'time_punch.deleted' | 'payroll_period.closed' | 'user.created' | 'user.modified' | 'user.reactivated' | 'user.deactivated' | 'department.created' | 'department.modified' | 'department.deleted' | 'location.created' | 'location.modified' | 'location.deleted' | 'role.created' | 'role.modified' | 'role.deleted' required

Event

Response

Created

object'webhook' required

Example response

{
  "data": {
    "event": "user.created"
  }
}