Set webhook subscription active

Webhooks

PATCH/api/v1/scent/webhooks/{id}/active

An inactive subscription receives no deliveries and does not count toward your active-subscription cap.

Path parameters

idstring (uuid)Required

Body parameters

isActivebooleanRequired

Required. true activates, false deactivates. A body without isActive returns 400 VALIDATION_ERRORS and changes nothing.

Response

idstring (uuid)

isActiveboolean

Other responses

401No bearer token (UNAUTHORIZED_MISSING_TOKEN), an invalid token (UNAUTHORIZED_INVALID_TOKEN) or an expired one (UNAUTHORIZED_TOKEN_EXPIRED — mint a new token). UPSTREAM_AUTH_FAILED is different: a dependent service refused the Gateway itself. That is a server-side fault — retry later and do NOT re-mint your token. See the Errors guide.

403The route is not available to your credential (FORBIDDEN).

404Unknown subscription.

415The request body is not sent as application/json (UNSUPPORTED_MEDIA_TYPE).

429Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

502A dependent service returned an invalid response (BAD_GATEWAY). Retry with backoff.

503The service is temporarily unavailable (SERVICE_UNAVAILABLE). Retry with backoff.

504A dependent service did not respond in time (GATEWAY_TIMEOUT). Retry with backoff.

cURL

curl --request PATCH \
  --url https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/active \
  --header 'Authorization: Bearer $TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "isActive": true
  }'

JavaScript

const res = await fetch('https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/active', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    isActive: true
  }),
});
const { payload } = await res.json();

C#

var response = await httpClient.PatchAsJsonAsync(
    "https://api-omni.linra.net/api/v1/scent/webhooks/5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b/active",
    new
    {
        isActive = true
    });

var envelope = await response.Content.ReadFromJsonAsync<ApiResponse<object>>();

Response

{
  "state": "SUCCESS",
  "payload": {
    "id": "5b1e3a1c-9d2e-4f3a-8b1c-9f0a2e3d4c5b",
    "isActive": true
  },
  "details": null
}