---
title: "Create Webhook"
method: POST
path: "/v2/company/{company_id}/webhooks"
tags: ["Webhooks"]
---

# Create Webhook

`POST /v2/company/{company_id}/webhooks`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/company/{company_id}/webhooks`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`
- TypeScript: <https://skmtc.dev/7shifts/apis/7shifts-api/docs/v2/company/:company_id/webhooks/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `company_id` integer, required

## Headers

- `x-api-version` string: An API version
- `x-company-guid` string, uuid

## Request body

- object
  - `url` string, 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 `201`

Created

- object
  - `object` 'webhook', required
  - `data` object, required
    - `id` integer, required: Webhook ID
    - `company_id` integer, required: Company ID
    - `url` string, required: Webhook URL
    - `method` 'post' | 'get' | 'put' | 'patch' | 'delete', required: Webhook method
    - `event` string, required: Webhook event
    - `created` string, required: Webhook create date time. UTC date time in ISO8601 format
    - `modified` string, required: Webhook modified date time. UTC date time in ISO8601 format

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `409`: Conflict
- `422`: Unprocessable Entity
- `500`: Server Error

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)