{"openapi":"3.0.1","info":{"description":"To interact with notification external service.\n <b><h1>Deprecated endpoints:</h1></b><table border=\"1px;\"><tr><th style=\"text-align: center; vertical-align: middle;\"><b><h3>Uri</b></h3></th><th><b>Method</b></th><th><b><h3>Since</h3></b></th><th><b><h3>End of life</h3></b></th></tr></table>","title":"External notifications","version":"1-core"},"servers":[{"url":"api.test.bluestonepim.com/notification-external","description":"Generated server url"}],"tags":[{"description":"To interact with subscriptions webhook.","name":"Subscriptions webhook"},{"description":"To interact with webhooks.","name":"Webhooks"},{"description":"To interact with subscriptions email.","name":"Subscriptions email"},{"description":"To interact with subscriptions in-app.","name":"Subscriptions in-app"},{"description":"To interact with webhook messages.","name":"Webhook messages"},{"description":"To interact with messages in-app.","name":"Messages in-app"},{"description":"To interact with email messages.","name":"Email messages"},{"description":"To interact with subscriptions apps queue webhook.","name":"Subscriptions apps queue webhook"},{"description":"To interact with subscriptions watch.","name":"Subscriptions watch"},{"description":"To interact with user configuration.","name":"User configuration"}],"paths":{"/messages/email/list":{"post":{"operationId":"getEmailMessages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageListResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get email messages.","tags":["Email messages"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/email/{messageId}":{"get":{"operationId":"getEmailMessage","parameters":[{"in":"path","name":"messageId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Get email message.","tags":["Email messages"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/in-app/list":{"post":{"operationId":"getInAppMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InAppMessageSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InAppMessageListResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get in-app messages.","tags":["Messages in-app"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/user/in-app/list":{"post":{"operationId":"getInAppUserMessage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InAppMessageSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InAppUserMessageListResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get in-app user messages.","tags":["Messages in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/user/in-app/readall":{"put":{"operationId":"markAllMessagesAsRead","responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Mark all messages as read.","tags":["Messages in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/user/in-app/{messageId}/read":{"put":{"operationId":"markMessageAsRead","parameters":[{"in":"path","name":"messageId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Mark message as read.","tags":["Messages in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/user/in-app/{messageId}/unread":{"put":{"operationId":"markMessageAsUnread","parameters":[{"in":"path","name":"messageId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Mark message as unread.","tags":["Messages in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/webhook":{"post":{"operationId":"pingWebhook","parameters":[{"in":"query","name":"url","required":true,"schema":{"type":"string"}},{"in":"query","name":"secret","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCall"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Ping webhook.","tags":["Webhook messages"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/messages/webhook/list":{"post":{"operationId":"getMessages","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookMessageSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookMessageResponse"}}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get messages for a given webhook.","tags":["Webhook messages"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/user":{"get":{"operationId":"findUserConfig","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get general user configuration.","tags":["User configuration"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"patch":{"operationId":"upsert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserConfigurationRequest"}}},"required":true},"responses":{"202":{"content":{},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Modify general user configuration.","tags":["User configuration"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/user/email/aggregation/entity/{entityType}":{"get":{"operationId":"findConfiguration","parameters":[{"in":"path","name":"entityType","required":true,"schema":{"type":"string","enum":["TASK","PRODUCT","CATEGORY","ASSET"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrequencyConfigResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get user aggregation configuration for given entity type.","tags":["Subscriptions email"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"updateEmailFrequency","parameters":[{"in":"path","name":"entityType","required":true,"schema":{"type":"string","enum":["TASK","PRODUCT","CATEGORY","ASSET"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrequencyConfigRequest"}}},"required":true},"responses":{"202":{"content":{},"description":"Accepted"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Modify user aggregation configuration for given entity type.","tags":["Subscriptions email"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/user/email/events":{"delete":{"operationId":"unsubscribeEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEventTypeListRequest"}}},"required":true},"responses":{"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Unsubscribe for given events for email channel.","tags":["Subscriptions email"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"get":{"operationId":"findEmail","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get all events subscriptions enabled for email channel.","tags":["Subscriptions email"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"subscribeEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEventTypeListRequest"}}},"required":true},"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Subscribe for given events for email channel.","tags":["Subscriptions email"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/user/in-app/events":{"delete":{"operationId":"unsubscribeInApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEventTypeListRequest"}}},"required":true},"responses":{"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Unsubscribe for given events for in-app channel.","tags":["Subscriptions in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"get":{"operationId":"findInApp","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get all events subscriptions enabled for in-app channel.","tags":["Subscriptions in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"subscribeInApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserEventTypeListRequest"}}},"required":true},"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Subscribe for given events for in-app channel.","tags":["Subscriptions in-app"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/user/watch/event/{eventType}":{"delete":{"operationId":"unsubscribeFromEntity","parameters":[{"in":"path","name":"eventType","required":true,"schema":{"type":"string","enum":["PRODUCT_WATCH"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityWatchRequest"}}},"required":true},"responses":{"204":{"content":{},"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Unsubscribe watch for given entities.","tags":["Subscriptions watch"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"get":{"operationId":"findWatchedEntities","parameters":[{"in":"path","name":"eventType","required":true,"schema":{"type":"string","enum":["PRODUCT_WATCH"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityWatchResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get all entities watched for given eventType.","tags":["Subscriptions watch"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"READ","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"subscribeToEntity","parameters":[{"in":"path","name":"eventType","required":true,"schema":{"type":"string","enum":["PRODUCT_WATCH"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityWatchRequest"}}},"required":true},"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Subscribe watch for given entities.","tags":["Subscriptions watch"],"x-bluestone-allowed-user-types":["RESTRICTED","STANDARD"],"x-bluestone-permission":[{"accessType":"WRITE","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/webhook/{webhookId}/apps":{"get":{"operationId":"getUseAppsQueue","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookAppsQueueResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Get info about apps queue webhook.","tags":["Subscriptions apps queue webhook"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"updateAppsQueue","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookAppsQueueUpdateRequest"}}},"required":true},"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Update apps queue for the given webhook.","tags":["Subscriptions apps queue webhook"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/subscriptions/webhook/{webhookId}/events":{"delete":{"operationId":"unsubscribe","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventTypeListRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Unsubscribe for given events for given webhook.","tags":["Subscriptions webhook"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"get":{"operationId":"findWebhook","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Get all events subscriptions enabled for given webhook.","tags":["Subscriptions webhook"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"subscribe","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventTypeListRequest"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Subscribe for given events for given webhook.","tags":["Subscriptions webhook"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/webhooks":{"post":{"operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateRequest"}}},"required":true},"responses":{"201":{"content":{},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict\n\nThis response indicates that the request could not be completed due to a conflict with the current state of the target resource. This typically occurs when there are duplicate entries or other data conflicts."}},"summary":"Create webhook.","tags":["Webhooks"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/webhooks/list":{"post":{"operationId":"search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookListResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."}},"summary":"Search webhook.","tags":["Webhooks"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}},"/webhooks/{webhookId}":{"delete":{"operationId":"delete","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Delete webhook.","tags":["Webhooks"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"get":{"operationId":"get","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"Get webhook.","tags":["Webhooks"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]},"put":{"operationId":"update","parameters":[{"in":"path","name":"webhookId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdateRequest"}}},"required":true},"responses":{"200":{"content":{},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request\n\nThis response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found\n\nThis response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist."}},"summary":"[ASYNCHRONOUS ENDPOINT] Update webhook.","tags":["Webhooks"],"x-bluestone-allowed-user-types":["STANDARD"],"x-bluestone-permission":[{"accessType":"ADMIN","module":"NOTIFICATIONS"}],"security":[{"oauth2":[]}]}}},"components":{"schemas":{"AggregationFrequencyRequest":{"type":"object","properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"title":"Day of week on which to send weekly notification."},"frequencyType":{"type":"string","enum":["HOURLY","DAILY","WEEKLY"],"title":"The frequency setting."},"hour":{"type":"integer","format":"int32","maximum":23,"minimum":0,"title":"Hour on which to send weekly or daily notification."},"timeZoneId":{"type":"string","example":"GMT+1","title":"Client time zone ID."}},"required":["dayOfWeek","frequencyType","hour","timeZoneId"]},"AggregationFrequencyResponse":{"type":"object","properties":{"dayOfWeek":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"title":"Day of week on which to send weekly notification."},"frequencyType":{"type":"string","enum":["HOURLY","DAILY","WEEKLY"],"title":"The frequency setting."},"hour":{"type":"integer","format":"int32","title":"Hour on which to send weekly or daily notification."},"timeZoneId":{"type":"string","title":"Client time zone ID."}},"required":["dayOfWeek","frequencyType","hour","timeZoneId"]},"ConflictingEntity":{"properties":{"entityId":{"type":"string","title":"Identifier of the related entity causing the conflict"}}},"EmailMessageListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailMessageResponse"},"title":"Email messages information list."}},"required":["data"]},"EmailMessageResponse":{"type":"object","properties":{"content":{"type":"string","title":"Message content."},"contentType":{"type":"string","title":"Message content type."},"createDate":{"type":"integer","format":"int64","title":"Create date."},"deliveryStatus":{"type":"string","enum":["TO_BE_SENT","SENT","ERROR","IN_PROGRESS"],"title":"Delivery status."},"id":{"type":"string","title":"Message id."},"recipient":{"type":"array","items":{"$ref":"#/components/schemas/EmailRecipient"},"title":"List of recipients."},"subject":{"type":"string","title":"Subject."}},"required":["content","deliveryStatus","id","recipient","subject"]},"EmailMessageSearchRequest":{"type":"object","properties":{"fromCreationDate":{"type":"integer","format":"int64","title":"Filter greater than or equal to the given creation date."},"ids":{"type":"array","items":{"type":"string"},"title":"List of messages ids."},"page":{"type":"integer","format":"int64","minimum":0,"title":"A number sequence representing a block of items to return as a result set."},"pageSize":{"type":"integer","format":"int32","example":10,"maximum":100,"minimum":1,"title":"Size of a block of items to return. It corresponds with the page parameter."},"toCreationDate":{"type":"integer","format":"int64","title":"Filter less than or equal to the given creation date."}},"required":["page","pageSize"]},"EmailRecipient":{"type":"object","properties":{"emailAddress":{"type":"string"}},"required":["emailAddress"]},"EntityWatchRequest":{"type":"object","properties":{"entityIds":{"type":"array","items":{"type":"string"},"title":"List of entities ids."}},"required":["entityIds"]},"EntityWatchResponse":{"type":"object","properties":{"entityIds":{"type":"array","items":{"type":"string"},"title":"List of entities ids."}}},"ErrorDetails":{"properties":{"field":{"type":"string","title":"Error related field."},"message":{"type":"string","title":"Error message."},"rejectedValue":{"type":"string","title":"Invalid value causing error."}}},"ErrorResponse":{"properties":{"conflictingEntities":{"type":"array","items":{"$ref":"#/components/schemas/ConflictingEntity"},"title":"Additional entity id list related to error"},"error":{"type":"string","title":"General error description."},"errorDetails":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetails"},"title":"List of errors details."},"quotaLimitExceededDetails":{"type":"array","items":{"$ref":"#/components/schemas/LimitExceededDetails"},"title":"Additional details related to quota limit exceeded errors"},"requestId":{"type":"string","title":"Request ID used for logging."},"status":{"type":"integer","format":"int32","title":"Error status code."},"timestamp":{"type":"integer","format":"int64","title":"Error timestamp."}}},"FrequencyConfigRequest":{"type":"object","properties":{"aggregated":{"type":"boolean","title":"Flag determine if notifications will be sent at a frequency specified in the aggregationFrequency object."},"aggregationFrequency":{"$ref":"#/components/schemas/AggregationFrequencyRequest","title":"Aggregation frequency."},"immediately":{"type":"boolean","title":"Flag determine if notifications will be sent immediately."}},"required":["aggregated","aggregationFrequency","immediately"]},"FrequencyConfigResponse":{"type":"object","properties":{"aggregated":{"type":"boolean","title":"Flag determine if notifications will be sent at a frequency specified in the aggregationFrequency object."},"aggregationFrequency":{"$ref":"#/components/schemas/AggregationFrequencyResponse","title":"Aggregation frequency."},"immediately":{"type":"boolean","title":"Flag determine if notifications will be sent immediately."}},"required":["aggregated","aggregationFrequency","immediately"]},"InAppMessageListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InAppMessageResponse"},"title":"In-app messages information list."}},"required":["data"]},"InAppMessageResponse":{"type":"object","properties":{"content":{"type":"string","title":"Message content."},"contentType":{"type":"string","title":"Message content type."},"createDate":{"type":"integer","format":"int64","title":"Create date."},"id":{"type":"string","title":"Message id."},"recipient":{"type":"array","items":{"$ref":"#/components/schemas/InAppRecipient"},"title":"List of message recipients."}},"required":["content","id","recipient"]},"InAppMessageSearchRequest":{"type":"object","properties":{"fromCreationDate":{"type":"integer","format":"int64","title":"Filter greater than or equal to the given creation date."},"ids":{"type":"array","items":{"type":"string"},"title":"List of messages ids."},"page":{"type":"integer","format":"int64","minimum":0,"title":"A number sequence representing a block of items to return as a result set."},"pageSize":{"type":"integer","format":"int32","example":10,"maximum":100,"minimum":1,"title":"Size of a block of items to return. It corresponds with the page parameter."},"status":{"type":"string","enum":["READ","NOT_READ"],"title":"Message status."},"toCreationDate":{"type":"integer","format":"int64","title":"Filter less than or equal to the given creation date."}},"required":["page","pageSize"]},"InAppRecipient":{"type":"object","properties":{"id":{"type":"string"},"messageStatus":{"type":"string","enum":["READ","NOT_READ"]}},"required":["id","messageStatus"]},"InAppUserMessageListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InAppUserMessageResponse"},"title":"In-app user messages information list."}},"required":["data"]},"InAppUserMessageResponse":{"type":"object","properties":{"content":{"type":"string","title":"Message content."},"contentType":{"type":"string","title":"Message content type."},"createDate":{"type":"integer","format":"int64","title":"Create date."},"id":{"type":"string","title":"Message id."},"status":{"type":"string","enum":["READ","NOT_READ"],"title":"Message status."}},"required":["content","id"]},"LimitExceededDetails":{"properties":{"entityId":{"type":"string","title":"ID of the entity that violated the quota"},"entityType":{"type":"string","title":"Type of the entity that violated the quota"},"limit":{"type":"integer","format":"int32","title":"Allowed limit"},"message":{"type":"string","title":"Detailed quota error message"},"quota":{"type":"string","title":"Unique quota identifier"}}},"PropertyUpdateString":{"type":"object","properties":{"value":{"type":"string","title":"Nullable value for partial upsert."}}},"SubscriptionResponse":{"type":"object","properties":{"eventTypes":{"type":"array","items":{"type":"string","enum":["TASK_IS_ASSIGNED_TO_USER","TASK_IS_REASSIGNED","TASK_METADATA_IS_UPDATED","NEW_COMMENT_ASSIGNED_TO_TASK","TASK_DUE_DATE_UPDATED","TASK_SCOPE_IS_UPDATED","TASK_REPORTED_BY_ME_IS_CLOSED","TASK_DEADLINE_REACHED","TASK_DEADLINE_REMINDER","PRODUCT_CREATED","PRODUCT_WATCH","PRODUCT_WATCH_ASSET","PRODUCT_WATCH_ASSET_ORDER","PRODUCT_WATCH_ATTRIBUTE","PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE","PRODUCT_WATCH_ATTRIBUTE_ASSOCIATION","PRODUCT_WATCH_ATTRIBUTE_DISASSOCIATION","PRODUCT_WATCH_BUNDLE","PRODUCT_WATCH_BUNDLE_QUANTITY","PRODUCT_WATCH_CATEGORY","PRODUCT_WATCH_LABEL","PRODUCT_WATCH_METADATA_NAME","PRODUCT_WATCH_METADATA_NUMBER","PRODUCT_WATCH_METADATA_DESCRIPTION","PRODUCT_WATCH_RELATION","PRODUCT_WATCH_STATE","PRODUCT_WATCH_VARIANT","PRODUCT_WATCH_GROUP","PRODUCT_SYNC_DONE","CATEGORY_WATCH_METADATA_NAME","CATEGORY_WATCH_METADATA_NUMBER","CATEGORY_WATCH_METADATA_DESCRIPTION","CATEGORY_WATCH_ATTRIBUTE","CATEGORY_LOCAL_WATCH_ATTRIBUTE","CATEGORY_LOCAL_WATCH_ATTRIBUTE_ASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_DISASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_UPDATE_VALUE","CATEGORY_WATCH_ASSET","CATEGORY_CREATED","CATEGORY_REMOVED","CATEGORY_WATCH","CATEGORY_WATCH_ARCHIVE_STATE","CATEGORY_WATCH_ORDER","CATEGORY_WATCH_MOVE","ASSET_CREATED","ASSET_WATCH_METADATA_NAME","ASSET_WATCH_METADATA_NUMBER","ASSET_WATCH_METADATA_DESCRIPTION","ASSET_WATCH_ATTRIBUTE_UPDATE_VALUE","ASSET_WATCH_ATTRIBUTE_ASSOCIATION","ASSET_WATCH_ATTRIBUTE_DISASSOCIATION"]},"title":"List of event types."}},"required":["eventTypes"]},"UserConfigurationRequest":{"type":"object","properties":{"userEmail":{"$ref":"#/components/schemas/PropertyUpdateString","title":"User email."}}},"UserConfigurationResponse":{"type":"object","properties":{"userEmail":{"type":"string","title":"User email."}}},"UserEventTypeListRequest":{"type":"object","properties":{"eventTypes":{"type":"array","items":{"type":"string","enum":["TASK_IS_ASSIGNED_TO_USER","TASK_IS_REASSIGNED","TASK_METADATA_IS_UPDATED","NEW_COMMENT_ASSIGNED_TO_TASK","TASK_DUE_DATE_UPDATED","TASK_SCOPE_IS_UPDATED","TASK_REPORTED_BY_ME_IS_CLOSED","PRODUCT_WATCH","TASK_DEADLINE_REACHED","TASK_DEADLINE_REMINDER"]},"minItems":1,"title":"List of event types."}},"required":["eventTypes"]},"WebhookAppsQueueResponse":{"type":"object","properties":{"enabled":{"type":"boolean","title":"Flag determines if apps queue is enabled."}},"required":["enabled"]},"WebhookAppsQueueUpdateRequest":{"type":"object","properties":{"enabled":{"type":"boolean","title":"Flag determines if apps queue is enabled."}},"required":["enabled"]},"WebhookCall":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/WebhookRequest"},"response":{"$ref":"#/components/schemas/WebhookResponse"},"timestamp":{"type":"integer","format":"int64"}},"required":["request","response","timestamp"]},"WebhookCreateRequest":{"type":"object","properties":{"active":{"type":"boolean","title":"Active flag."},"secret":{"type":"string","minLength":1,"title":"Secret information."},"url":{"type":"string","minLength":1,"title":"Url information."}},"required":["active","secret","url"]},"WebhookEventTypeListRequest":{"type":"object","properties":{"eventTypes":{"type":"array","items":{"type":"string","enum":["PRODUCT_WATCH_ASSET","PRODUCT_WATCH_ASSET_ORDER","PRODUCT_WATCH_ATTRIBUTE","PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE","PRODUCT_WATCH_ATTRIBUTE_ASSOCIATION","PRODUCT_WATCH_ATTRIBUTE_DISASSOCIATION","PRODUCT_WATCH_BUNDLE","PRODUCT_WATCH_BUNDLE_QUANTITY","PRODUCT_WATCH_CATEGORY","PRODUCT_WATCH_LABEL","PRODUCT_WATCH_METADATA_NAME","PRODUCT_WATCH_METADATA_NUMBER","PRODUCT_WATCH_METADATA_DESCRIPTION","PRODUCT_WATCH_RELATION","PRODUCT_WATCH_STATE","PRODUCT_WATCH_VARIANT","PRODUCT_WATCH_GROUP","PRODUCT_CREATED","PRODUCT_SYNC_DONE","CATEGORY_WATCH_METADATA_NAME","CATEGORY_WATCH_METADATA_NUMBER","CATEGORY_WATCH_METADATA_DESCRIPTION","CATEGORY_WATCH_ARCHIVE_STATE","CATEGORY_WATCH_MOVE","CATEGORY_WATCH_ORDER","CATEGORY_WATCH_ATTRIBUTE","CATEGORY_LOCAL_WATCH_ATTRIBUTE_ASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_DISASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_UPDATE_VALUE","CATEGORY_WATCH_ASSET","CATEGORY_CREATED","CATEGORY_REMOVED","ASSET_CREATED","ASSET_WATCH_METADATA_NAME","ASSET_WATCH_METADATA_NUMBER","ASSET_WATCH_METADATA_DESCRIPTION","ASSET_WATCH_ATTRIBUTE_UPDATE_VALUE","ASSET_WATCH_ATTRIBUTE_ASSOCIATION","ASSET_WATCH_ATTRIBUTE_DISASSOCIATION"]},"minItems":1,"title":"List of event types."}},"required":["eventTypes"]},"WebhookListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"},"title":"Webhooks information list."}},"required":["data"]},"WebhookMessageResponse":{"type":"object","properties":{"calls":{"type":"array","items":{"$ref":"#/components/schemas/WebhookCall"},"title":"Calls."},"content":{"type":"string","title":"Message content."},"createdAt":{"type":"integer","format":"int64","title":"Created at."},"eventType":{"type":"string","enum":["TASK_IS_ASSIGNED_TO_USER","TASK_IS_REASSIGNED","TASK_METADATA_IS_UPDATED","NEW_COMMENT_ASSIGNED_TO_TASK","TASK_DUE_DATE_UPDATED","TASK_SCOPE_IS_UPDATED","TASK_REPORTED_BY_ME_IS_CLOSED","TASK_DEADLINE_REACHED","TASK_DEADLINE_REMINDER","PRODUCT_CREATED","PRODUCT_WATCH","PRODUCT_WATCH_ASSET","PRODUCT_WATCH_ASSET_ORDER","PRODUCT_WATCH_ATTRIBUTE","PRODUCT_WATCH_ATTRIBUTE_UPDATE_VALUE","PRODUCT_WATCH_ATTRIBUTE_ASSOCIATION","PRODUCT_WATCH_ATTRIBUTE_DISASSOCIATION","PRODUCT_WATCH_BUNDLE","PRODUCT_WATCH_BUNDLE_QUANTITY","PRODUCT_WATCH_CATEGORY","PRODUCT_WATCH_LABEL","PRODUCT_WATCH_METADATA_NAME","PRODUCT_WATCH_METADATA_NUMBER","PRODUCT_WATCH_METADATA_DESCRIPTION","PRODUCT_WATCH_RELATION","PRODUCT_WATCH_STATE","PRODUCT_WATCH_VARIANT","PRODUCT_WATCH_GROUP","PRODUCT_SYNC_DONE","CATEGORY_WATCH_METADATA_NAME","CATEGORY_WATCH_METADATA_NUMBER","CATEGORY_WATCH_METADATA_DESCRIPTION","CATEGORY_WATCH_ATTRIBUTE","CATEGORY_LOCAL_WATCH_ATTRIBUTE","CATEGORY_LOCAL_WATCH_ATTRIBUTE_ASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_DISASSOCIATION","CATEGORY_LOCAL_WATCH_ATTRIBUTE_UPDATE_VALUE","CATEGORY_WATCH_ASSET","CATEGORY_CREATED","CATEGORY_REMOVED","CATEGORY_WATCH","CATEGORY_WATCH_ARCHIVE_STATE","CATEGORY_WATCH_ORDER","CATEGORY_WATCH_MOVE","ASSET_CREATED","ASSET_WATCH_METADATA_NAME","ASSET_WATCH_METADATA_NUMBER","ASSET_WATCH_METADATA_DESCRIPTION","ASSET_WATCH_ATTRIBUTE_UPDATE_VALUE","ASSET_WATCH_ATTRIBUTE_ASSOCIATION","ASSET_WATCH_ATTRIBUTE_DISASSOCIATION"],"title":"Event type."},"id":{"type":"string","title":"Message id."},"status":{"type":"string","enum":["TO_BE_SENT","SENT","ERROR","WEBHOOK_INACTIVE","IN_PROGRESS"],"title":"Status."},"webhookId":{"type":"string","title":"Webhook id."}},"required":["content","createdAt","id","status","webhookId"]},"WebhookMessageSearchRequest":{"type":"object","properties":{"page":{"type":"integer","format":"int64","minimum":0,"title":"A number sequence representing a block of items to return as a result set."},"pageSize":{"type":"integer","format":"int32","example":10,"maximum":100,"minimum":1,"title":"Size of a block of items to return. It corresponds with the page parameter."},"status":{"type":"string","enum":["TO_BE_SENT","SENT","ERROR","WEBHOOK_INACTIVE","IN_PROGRESS"],"title":"Webhook message status."},"webhookId":{"type":"string","title":"Webhook id."}},"required":["page","pageSize","webhookId"]},"WebhookRequest":{"type":"object","properties":{"headers":{"type":"array","items":{"type":"string"}},"httpMethod":{"type":"string"},"payload":{"type":"string"},"url":{"type":"string"}},"required":["httpMethod","payload","url"]},"WebhookResponse":{"type":"object","properties":{"active":{"type":"boolean","title":"Active flag."},"id":{"type":"string","title":"Id."},"retryAttempts":{"type":"integer","format":"int32","title":"Retries information."},"secret":{"type":"string","title":"Secret information."},"url":{"type":"string","title":"Url information."}},"required":["active","id","retryAttempts","secret","url"]},"WebhookSearchRequest":{"type":"object","properties":{"page":{"type":"integer","format":"int64","minimum":0,"title":"A number sequence representing a block of items to return as a result set."},"pageSize":{"type":"integer","format":"int32","example":10,"maximum":100,"minimum":1,"title":"Size of a block of items to return. It corresponds with the page parameter."}},"required":["page","pageSize"]},"WebhookUpdateRequest":{"type":"object","properties":{"active":{"type":"boolean","title":"Active flag."},"secret":{"type":"string","title":"Secret information."},"url":{"type":"string","title":"Url information."}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://idp.test.bluestonepim.com/op/token","scopes":{"openid profile systemRoles permissions organization email name nickname":"All needed scopes."}}}}}},"x-amazon-apigateway-api-key-source":"AUTHORIZER"}