post /mint/organizations/{org_name}/notification-conditions

Creates a notification condition and action. See also Configuring notification conditions and actions using the API.

HTTP request

https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions

Path Parameters

org_name (required)

string

Organization name.

Request Body

Notification condition and action.

application/json
NotificationRequest
if type is: object
notificationCondition

array

NotificationCondition
if type is: object
actions

array

NotificationAction
actionAttribute

string

Type of action. Valid values include: ORG_EMAIL (recipient identified by email address), DEV_ID (recipient identified by developer ID), COMPANY_ADMINS (recipients are all company administrators), and WEBHOOK (recipient is webhook callback handler.

condition

Condition

id

string

ID of the action.

postURL

string

Callback handler for the webhook.

Note: This option is valid only if actionAttribute is set to WEBHOOK.

templateId

string

ID of the notification template.

Note: This option is not valid if actionAttribute is set to WEBHOOK.

value

string

Value of the action attribute. If actionAttribute is set to ORG_EMAIL or DEV_ID, a value of ANY sends ther notification to any appliable recipent, for example, any ORG_EMAIL address or any DEV_ID. If actionAttribute is set to WEBHOOK, set this value to the ID of the webhook.

Response Types

200: 

OK

Body

application/json
NotificationCondition
if type is: object
name

string

Name of the notification condition. The name must be unique. Specify with attribute property only.

attribute

string

Attribute used to define the notification condition. You can specify one or more attributes to refine the notification condition. Specify with either name or value property only.

limit

object

id

string

ID of the notification template. Specify with value property only.

value

string

Value of the attribute used to trigger the action. Specify with either attribute or limit only.

Authentication Requirements

Available Authentication Options
  • Basic
  • OAuth

Try this API

Request parameters
org_name
Request body
Request body cannot be empty
Credentials
Multi-factor authentication is not supported.