---
title: "Create a webhook"
method: POST
path: "/webhooks"
tags: ["Webhooks"]
---

# Create a webhook

`POST /webhooks`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/webhooks`
- Auth: HTTP bearer

Create a webhook

 <b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>
 

 **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

## Request body

- WebhooksPostWebhooksRequestBody: This is the body of the webhook POST request.
  - `customHeaders` CustomHeadersObjectRequestBody[]: The list of custom headers that users can include with their request
    - `key` string, required: The alphanumeric key of the custom header.
    - `value` string, required: The value of the custom header. The default maximum length of the value is 100 characters.
  - `eventTypes` string[]: [beta] The list of event types associated with a particular event type
  - `name` string, required: The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.
  - `url` string, required: The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.
  - `version` '2018-01-01' | '2021-06-09' | '2022-09-13' | '2024-02-27': The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`, `2022-09-13`, `2024-02-27`

## Response `200`

OK response.

- WebhooksPostWebhooksResponseBody
  - `customHeaders` CustomHeadersObjectResponseBody[]: The list of custom headers that users can include with their request
    - `key` string, required: The alphanumeric key of the custom header.
    - `value` string, required: The value of the custom header. The default maximum length of the value is 100 characters.
  - `eventTypes` string[]: The list of event types associated with a particular webhook.
  - `id` string, required: The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated.
  - `name` string, required: The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.
  - `secretKey` string, required: The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.
  - `url` string, required: The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.
  - `version` '2018-01-01' | '2021-06-09', required: The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

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