SAsamsara
Webhooks

Update a specific webhook's information.

Update a specific webhook's information. Note this implementation of patch uses the JSON merge patch proposed standard. This means that any fields included in the patch request will overwrite fields which exist on the target resource. For arrays, this means any array included in the request will replace the array that exists at the specified path, it will not add to the existing array

<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.

patch/webhooks/{id}

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the webhook to update.

Request body

namestring

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.

urlstring

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

Example request

{
  "customHeaders": [
    {
      "key": "format",
      "value": "xcmol-532"
    }
  ],
  "name": "Webhook-123",
  "url": "https://www.webhook-123.com/webhook/listener",
  "version": "2018-01-01"
}

Response

OK response.

eventTypesstring[]

The list of event types associated with a particular webhook.

idstring 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.

namestring 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.

secretKeystring required

The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.

urlstring 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

Example response

{
  "customHeaders": [
    {
      "key": "format",
      "value": "xcmol-532"
    }
  ],
  "eventTypes": [
    "AddressCreated",
    "AddressCreated",
    "AddressCreated",
    "AddressCreated"
  ],
  "id": "23918",
  "name": "Webhook-123",
  "secretKey": "11121-31231-1231212",
  "url": "https://www.webhook-123.com/webhook/listener",
  "version": "2018-01-01"
}

Changes

No recorded changes to this operation across all 1 revision of this API.