Subscribe to notifications for a specific item

POST

/v1/notifications/subscriptions

const url = 'https://api.adversarial.com/api/v1/notifications/subscriptions';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '[{"item_identifier":"example","notification_type":"AssignedRisk"}]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.adversarial.com/api/v1/notifications/subscriptions \
  --header 'Content-Type: application/json' \
  --data '[ { "item_identifier": "example", "notification_type": "AssignedRisk" } ]'

Request Body^required

application/json

Array<object>

Payload for subscribing to individual items This is separate from SubscriptionPayload to enforce that item_identifier is required

object

item_identifier

required

The identifier of the specific item (e.g., “RSK-123”, “INC-456”)

string

notification_type

required

string

Allowed values: AssignedRisk RiskChanged NewRiskComment NewLowRisk NewMediumRisk NewHighRisk NewCriticalRisk IncChanged NewSev1Inc NewSev2Inc NewSev3Inc NewFraudInc NewExtortionInc NewSabotageInc NewDataDisclosureInc NewCustomerTargetingInc NewResourceHijackingInc NewIncComment AssignedInc DowngradedInc InvitedToOrg RisksCreated IncidentsCreated Mentioned

Responses

200

Successfully added subscription

400

Invalid request - notification types that are not for specific risks or incidents must use preferences endpoints

404

Could not add subscription

Subscribe to notifications for a specific item

Request Bodyrequired

Responses

200

400

404

Request Body^required