NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

Webhooks → Update API Webhook configuration

AI-generated

Summary

Update the configuration of an existing API webhook in NinjaOne by specifying parameters such as callback URL, activity filters, headers, and organization IDs.

Inputs

  • additionalFields — Optional fields to customize the webhook, including 'url' (callback URL), 'activities' (activity filter as JSON), 'expand' (array of references to expand in payloads), 'headers' (custom HTTP headers as JSON), and 'organizationIds' (list of organization IDs as JSON).
  • options — Optional configuration for request behavior and customization, including custom request body, custom HTTP headers, query filters, batching options, debug flag, pagination parameters, and request timeout.

Output shape

a single JSON object representing the updated webhook configuration returned by the API, potentially including debug information if enabled.

Supports deep merging of custom body fields with standard parameters, and allows adding custom headers and query parameters. Pagination options present are generally unused for this update operation. Debug option appends detailed request data on success or failure.

Examples

Example 1: Update a webhook to change its callback URL and add a header

Set 'url' in additionalFields to new webhook URL, add an Authorization header in additionalFields.headers or options.headerFilters.

Links

Discussion