Konnect Notification Hub (1.0.0)

Download OpenAPI specification:Download

URL: https://konghq.com

Notification Hub API for Konnect.

Notifications

Operations related to notifications

List available notifications.

Authorizations:

personalAccessToken

query Parameters

page[before]	string Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item before this parameter.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.
	object (NotificationFilterParameters) Filters a collection of notifications.

Responses

Response samples

200
400
401
403

Content type

application/json

{"data": [{"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"title": "Unpaid invoice reminder",
"description": "Reminder for an unpaid invoice.",
"status": "UNREAD",
"region": "US",
"namespace": "plan-and-usage",
"entity_id": "invoice-1",
"details": {"entity_id": "invoice-1",
"entity_type": "invoice"
},
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
},
{"id": "93f8380e-7798-4566-99e3-2edf2b57d290",
"title": "Unpaid invoice reminder",
"description": "Reminder for an unpaid invoice.",
"status": "UNREAD",
"region": "EU",
"namespace": "plan-and-usage",
"entity_id": "invoice-2",
"details": {"entity_id": "invoice-2",
"entity_type": "invoice"
},
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}
],
"meta": {"next": "",
"previous": "",
"size": 10
}
}

Get notification details.

Authorizations:

personalAccessToken

path Parameters

notificationId

required

string

ID of the notification.

Responses

Response samples

200
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d290",
"title": "Unpaid invoice reminder",
"description": "Reminder for an unpaid invoice.",
"status": "UNREAD",
"region": "EU",
"namespace": "plan-and-usage",
"entity_id": "invoice-1",
"details": {"entity_id": "invoice-1",
"entity_type": "invoice",
"regions": ["EU"
]
},
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Update notification.

Authorizations:

personalAccessToken

path Parameters

notificationId

required

string

ID of the notification.

Request Body schema: application/json

Request body schema for updating notification status.

status

required

string (NotificationStatus)

Enum: "READ" "UNREAD" "ARCHIVED"

Status of the notification.

Responses

Request samples

Payload

Content type

application/json

{"status": "READ"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d290",
"title": "Unpaid invoice reminder",
"description": "Reminder for an unpaid invoice.",
"status": "UNREAD",
"region": "EU",
"namespace": "plan-and-usage",
"entity_id": "invoice-1",
"details": {"entity_id": "invoice-1",
"entity_type": "invoice",
"regions": ["EU"
]
},
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Delete notification.

Authorizations:

personalAccessToken

path Parameters

notificationId

required

string

ID of the notification.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}

Mark a list of notifications to a status.

Authorizations:

personalAccessToken

Request Body schema: application/json

Request body schema for bulk status update.

ids required	Array of strings [ 1 .. 100 ] items unique
status required	string (NotificationStatus) Enum: "READ" "UNREAD" "ARCHIVED" Status of the notification.

Responses

Request samples

Payload

Content type

application/json

{"ids": ["93f8380e-7798-4566-99e3-2edf2b57d289",
"93f8380e-7798-4566-99e3-2edf2b57d290"
],
"status": "READ"
}

Response samples

400
401
403
404

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

List available user configurations.

Authorizations:

personalAccessToken

query Parameters

object (ConfigurationFilterParameters)

Filters a collection of configurations.

Responses

Response samples

200
400
401
403

Content type

application/json

{"data": [{"event_id": "billing.invoice.unpaid-reminder",
"event_title": "Unpaid invoice reminder",
"event_description": "Reminder for an unpaid invoice",
"event_namespace": "plan-and-usage",
"event_subscription_count": 2,
"default_subscription": [{"channel": "IN_APP",
"enabled": true
},
{"channel": "EMAIL",
"enabled": true
}
]
}
]
}

List event subscriptions.

Authorizations:

personalAccessToken

path Parameters

eventId

required

string

Example: invoice-ready

Formatted string ID of the notification event.

Responses

Response samples

200
400
401
403

Content type

application/json

{"data": [{"id": "93f8380e-7798-4566-99e3-2edf2b57d291",
"regions": ["US",
"EU"
],
"entities": ["invoice-1",
"invoice-2"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
},
{"id": "93f8380e-7798-4566-99e3-2edf2b57d292",
"regions": ["*"
],
"entities": ["*"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}
],
"meta": {"next": "",
"previous": "",
"size": 10
}
}

Create a new subscription for an event.

Authorizations:

personalAccessToken

path Parameters

eventId

required

string

Example: invoice-ready

Formatted string ID of the notification event.

Request Body schema: application/json

Request body schema for creating/updating event subscription.

regions required	Array of strings (NotificationRegion) Items Enum: "US" "EU" "AU" "*"
entities required	Array of strings
required	Array of objects (NotificationChannel)
enabled required	boolean Enable/Disable complete subscription within an event.

Responses

Request samples

Payload

Content type

application/json

{"regions": ["US",
"EU"
],
"entities": ["control-plane-1",
"control-plane-2"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Response samples

201
400
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d292",
"regions": ["*"
],
"entities": ["*"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Get subscription for an event.

Authorizations:

personalAccessToken

path Parameters

eventId required	string Example: invoice-ready Formatted string ID of the notification event.
subscriptionId required	string Subscription ID of the user configuration.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d292",
"regions": ["*"
],
"entities": ["*"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Update subscription for an event.

Authorizations:

personalAccessToken

path Parameters

eventId required	string Example: invoice-ready Formatted string ID of the notification event.
subscriptionId required	string Subscription ID of the user configuration.

Request Body schema: application/json

Request body schema for creating/updating event subscription.

regions required	Array of strings (NotificationRegion) Items Enum: "US" "EU" "AU" "*"
entities required	Array of strings
required	Array of objects (NotificationChannel)
enabled required	boolean Enable/Disable complete subscription within an event.

Responses

Request samples

Payload

Content type

application/json

{"regions": ["US",
"EU"
],
"entities": ["control-plane-1",
"control-plane-2"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d292",
"regions": ["*"
],
"entities": ["*"
],
"channels": [{"type": "IN_APP",
"enabled": true
},
{"type": "EMAIL",
"enabled": true
}
],
"enabled": true,
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Delete subscription associated with event.

Authorizations:

personalAccessToken

path Parameters

eventId required	string Example: invoice-ready Formatted string ID of the notification event.
subscriptionId required	string Subscription ID of the user configuration.

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}