Create a webhook

Create a webhook

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Webhooks under the Setup & Administration category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
customHeaders
array of objects
length ≤ 5

The list of custom headers that users can include with their request

customHeaders
eventTypes
array of strings

[beta] The list of event types associated with a particular event type

eventTypes
string
required
length ≤ 255

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.

string
required
length ≤ 2047

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.

string
enum

The version of the webhook. Valid values: 2018-01-01, 2021-06-09, 2022-09-13, 2024-02-27

Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json