openapi: 3.0.3
info:
title: Gencove Back array notification API
version: v2
contact:
email: support@gencove.com
license:
name: Proprietary
description: API for Gencove REST service. Visit <a href='https://enterprise.gencove.com/'>enterprise.gencove.com</a> and <a href='https://docs.gencove.com/'>docs.gencove.com</a> for more information. <br><hr><p>To work with Insomnia, you can generate a Gencove API key by <a target='_blank' href='https://web.gencove.com/account?filter=api-keys'>clicking here</a>. Once you have the API key and have imported the project in Insomnia as a <i>Request Collection</i>, enter the key in Insomnia under <i>Manage Environment</i>.</p><a href='https://insomnia.rest/run/?label=back_api2&uri=https%3A%2F%2Fv2-api-files-prod.s3.amazonaws.com%2Fpublic%2Finsomnia%2Finsomnia_gencove_prod.json' target='_blank'>Run in Insomnia</a><hr>
servers:
- url: https://api.gencove.com
tags:
- name: notification
paths:
/api/v2/notifications/{notification_id}:
get:
operationId: notifications_retrieve
description: 'List all available subscriptions for given project or create a new
subscription.'
parameters:
- in: path
name: notification_id
schema:
type: string
format: uuid
required: true
tags:
- notification
security:
- JWT: []
- API key: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectSubscriptionNotificationDetail'
description: ''
components:
schemas:
ProjectSubscriptionNotificationDetail:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
created:
type: string
format: date-time
response_status:
type: integer
maximum: 2147483647
minimum: -2147483648
nullable: true
notification_event_type:
type: string
readOnly: true
description: notification event type
response_message:
type: string
nullable: true
payload_url:
type: string
readOnly: true
description: presigned s3 url for the payload content
required:
- id
- notification_event_type
- payload_url
securitySchemes:
API key:
type: apiKey
description: 'Authorization header content formated as: `Api-Key <API-key>`
You can obtain new API key through Gencove''s web UI or `user-api-key` endpoint'
in: header
name: Authorization
JWT:
type: apiKey
description: 'Authorization header content formated as: `Bearer <json-web-token>`
You can obtain access token using `jwt-create` endpoint.'
in: header
name: Authorization