Skip to main content
PATCH
Post engagement monitoring requires a V2 workspace API key. Legacy V1 API keys are not supported by these endpoints. Monitors and their credits belong to the V2 workspace associated with the key.
Update any combination of name, frequency (daily or weekly), action (pause or resume), engagement_types, include_existing_engagers, filters, webhook_url (HTTPS URL or null), and rotate_signing_secret: true. Sources change through Add sources and Remove a source; any other field returns 422 invalid_monitor_update.

Pause and resume

Pause stops checks and holds queued webhooks until the monitor is resumed. Resume schedules a check immediately and requires monitoring to be available (503 monitoring_not_enabled) and at least 0.2 credits (402 insufficient_credits).

Settings

  • Changing frequency schedules the next check one period from now.
  • Changing engagement_types or filters restarts coverage. People already delivered stay delivered and are never charged again. filters replaces the whole filter object; omitted lists become empty.
  • Turning include_existing_engagers on delivers previously seen engagers on the next pass and charges them.

Change the webhook or recover a lost signing secret

  • Setting or changing webhook_url, or sending rotate_signing_secret: true, returns a new one-time signing_secret with signing_secret_warning. Store it immediately.
  • {"webhook_url": null} disables the webhook and clears the secret. Rotating without a webhook returns 422 webhook_not_configured; combining rotation with webhook_url: null returns 422 invalid_monitor_update.
  • Repeating the same URL without rotation returns no secret.
Queued deliveries made for the old configuration are cancelled (webhook_configuration_changed); use redelivery to send them again. If a delivery is being sent at that moment, the edit returns 409 webhook_delivery_in_progress and changes nothing; retry shortly. Configuration changes never spend credits.

Next step

Use Redeliver a webhook after changing the webhook URL.

Authorizations

Authorization
string
header
required

Use an Airscale workspace API key. Never expose the key in client-side code.

Path Parameters

monitor_id
string<uuid>
required

Body

application/json

Send at least one supported field. Any other field, including sources, is rejected.

name
string
Required string length: 1 - 120
frequency
enum<string>
Available options:
daily,
weekly
action
enum<string>
Available options:
pause,
resume
engagement_types
enum<string>[]
Required array length: 1 - 2 elements
Available options:
reactions,
comments
include_existing_engagers
boolean
filters
object

Replaces the monitor's filters. Omitted filter lists become empty.

webhook_url
string<uri> | null

Set or change the webhook (a public HTTPS URL without embedded credentials), or send null to disable it and clear its signing secret. Setting a new URL returns a fresh signing_secret.

Maximum string length: 2048
rotate_signing_secret
boolean

Generate a new signing secret for the enabled webhook. Cannot be combined with webhook_url: null.

Response

The updated monitor. signing_secret and signing_secret_warning appear only when a new secret was generated.

monitor
object
required
signing_secret
string

Present only when the request set a new webhook URL or rotated the secret. Store it immediately.

signing_secret_warning
string