Skip to content

Latest commit

 

History

History
361 lines (184 loc) · 10.7 KB

actions-and-endpoints.md

File metadata and controls

361 lines (184 loc) · 10.7 KB

Actions & Endpoints

Introduction

The Saas Alerts Integration with Rewst delivers a robust set of actions and endpoints for interacting with Saas Alerts. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Saas Alerts Integration:

Actions

Generic Request

SaaS Alerts API Request

GET <example>.com/<url_path>

Generic action for making authenticated requests against the SaaS Alerts API

Processed Event Webhooks

List Subscriptions Items

GET <example>.com/outgoingWebhookApi/api/v1/subscriptions

Retrieve list of active subscriptions for current partner

Create Subscription Item

POST <example>.com/outgoingWebhookApi/api/v1/subscriptions

Create new subscription

List Of Disabled Subscriptions Items

GET <example>.com/outgoingWebhookApi/api/v1/subscriptions/disabled

Retrieve list of disabled subscriptions for current partner

Delete Subscription Item

DELETE <example>.com/outgoingWebhookApi/api/v1/subscriptions/{channelId}

Delete subscription

Update Subscription Item

PATCH <example>.com/outgoingWebhookApi/api/v1/subscriptions/{channelId}

Update new subscription

Authorization Get Apikey

GET <example>.com/outgoingWebhookApi/api/v1/tools/apiKey

get ApiKey by idToken (This method is used via the Saas Alerts UI.), idToken - issued by 1 hour, apiKey - long life till reset it manually

Authorization Reset Apikey

POST <example>.com/outgoingWebhookApi/api/v1/tools/apiKey

reset ApiKey by idToken (This method is used via the Saas Alerts UI)

Domain Verification List Of Items

GET <example>.com/outgoingWebhookApi/api/v1/domains

Get List of verified domains (This method is used via the Saas Alerts UI)

Domain Verification Verify And Add Domain

POST <example>.com/outgoingWebhookApi/api/v1/domains

validate domain and save it in success case (This method is used via the Saas Alerts UI)

Domain Verification Delete Item

DELETE <example>.com/outgoingWebhookApi/api/v1/domains/{id}

delete validated domain (This method is used via the Saas Alerts UI)

Get Customers

GET <example>.com/outgoingWebhookApi/api/v1/misc/customers

Get List of Customers

Get Alert Types

GET <example>.com/outgoingWebhookApi/api/v1/misc/alertTypes

Get List of Alert Types

Subscription Test Event

POST <example>.com/outgoingWebhookApi/api/v1/misc/sendTestEvent

Send Test Event

Queue List Of Unsent Packs

GET <example>.com/outgoingWebhookApi/api/v1/queue

Retrieve list of unsent packs of events for current partner

Queue List Of Unsent Packs

GET <example>.com/outgoingWebhookApi/api/v1/queue/channels/{channelId}

Retrieve list of unsent packs of events for current channel

Queue List Of Events

GET <example>.com/outgoingWebhookApi/api/v1/queue/{queueId}/channels/{channelId}/events

Retrieve list of events for current channel

Queue Delete Item

DELETE <example>.com/outgoingWebhookApi/api/v1/queue/{queueId}/channels/{channelId}

Delete channel from queue

Processed Events Data

Event Data Query

POST <example>.com/reportApi/api/v1/reports/events/query

Retrieve events for specific query

Events Count Query

POST <example>.com/reportApi/api/v1/reports/events/count/query

Retrieve a count of events for a specific query

Raw Event Webhooks

Get Subscriptions

GET <example>.com/outgoingWebhookRawApi/api/v1/raw/subscriptions

Get a list of Saas Alert subcriptions against the Saas Alerts API

Create Subscription

POST <example>.com/outgoingWebhookRawApi/api/v1/raw/subscriptions

Create a subscription by channelId against the Saas Alerts API

Get Disabled Subscriptions

GET <example>.com/outgoingWebhookRawApi/api/v1/raw/subscriptions/disabled

Get a list of disabled SaaS Alert subscriptions.

Update Subscription

PATCH <example>.com/outgoingWebhookRawApi/api/v1/raw/subscriptions/{channelId}

Update a subscription by channelId against the Saas Alerts API

Delete Subscription

DELETE <example>.com/outgoingWebhookRawApi/api/v1/raw/subscriptions/{channelId}

Delete a subscription against the Saas Alerts API

Raw Send Test Event

POST <example>.com/outgoingWebhookRawApi/api/v1/misc/sendTestEvent

Create a debug test event against the Saas Alerts API

Get Endpoints

GET <example>.com/outgoingWebhookRawApi/api/v1/misc/endpoints/{productType}

Get a list of endpoints based on product type

Get Queues

GET <example>.com/outgoingWebhookRawApi/api/v1/queue

Get a list of unsent queues against the Saas Alerts API

Get Queues by Channel Id

GET <example>.com/outgoingWebhookRawApi/api/v1/queue/channels/{channelId}

Get a list of unsent queues by channel id

Get Events for Current Channel

GET <example>.com/outgoingWebhookRawApi/api/v1/queue/{queueId}/channels/{channelId}/events

Retrieve list of events for current channel

Delete a Channel

DELETE <example>.com/outgoingWebhookRawApi/api/v1/queue/{queueId}/channels/{channelId}

Queue - Delete a channel

Reports

Get Scheduled Reports

GET <example>.com/reportApi/api/v1/reports/scheduled-report

Retrieve all the scheduled reports of the partner

Add Scheduled Report

POST <example>.com/reportApi/api/v1/reports/scheduled-report

Add a scheduled report to the database

Get Scheduled Report by Id

GET <example>.com/reportApi/api/v1/reports/scheduled-report/{scheduledReportId}

Retrieve a scheduled report by scheduledReportId

Delete Scheduled Report

DELETE <example>.com/reportApi/api/v1/reports/scheduled-report/{scheduledReportId}

Delete scheduled report by scheduledReportId

Send Email Mailgun

POST <example>.com/reportApi/api/v1/reports/send-email

Send email via mailgun

Get Partner Info

GET <example>.com/reportApi/api/v1/reports/partners/profile

Retrieve Partner Profile information
Name, Address. Phone…etc

Get MSP User Info

GET <example>.com/reportApi/api/v1/reports/msp-user

Retrieve MSP User Information
ID, Name, Email, Role, PartnerId

Get Customer by Id

GET <example>.com/reportApi/api/v1/reports/customers/{id}

Retrieve customer by customer id

Get List of Customers

GET <example>.com/reportApi/api/v1/reports/customers

Retrieve a list of customers for the authenticated partner

List Users by Id

GET <example>.com/reportApi/api/v1/reports/users

Retrieve a list of users by Customer

Get Events by Customer

GET <example>.com/reportApi/api/v1/reports/events

Retrieve events by Customer and additional query values

Event Data by Query

POST <example>.com/reportApi/api/v1/reports/events/query

Retrieve events for specific query

Events Count by Query

GET <example>.com/reportApi/api/v1/reports/events/count

Retrieve a count of events using query parameters

Events Count by Body Query

POST <example>.com/reportApi/api/v1/reports/events/count/query

Retrieve a count of events for a specific query

Event Data Query with Pagination

POST <example>.com/reportApi/api/v1/reports/events/scroll

Retrieve events using pagination. This is used to pull large data sets. In the `/event/query` specify `scroll` parameter in seconds determine the length of time the query will run and return data

Get ApiKey

GET <example>.com/reportApi/api/v1/tools/apiKey

get ApiKey by idToken (This method is used via the Saas Alerts UI.), idToken - issued once per hour, apiKey - persists until reset it manually

Reset ApiKey by idToken

POST <example>.com/reportApi/api/v1/tools/apiKey

reset ApiKey by idToken (This method is used via the Saas Alerts UI)

Upload Files

POST <example>.com/reportApi/api/v1/files

Upload a file to cloud storage

Get Signed URL of Cloud Storage Object

GET <example>.com/reportApi/api/v1/files/{file}

Get signed url of the cloud storage object

Delete Signed URL of Cloud Storage Object

DELETE <example>.com/reportApi/api/v1/files/{file}

Remove uploaded file from cloud storage

Delete Customer

DELETE <example>.com/reportApi/api/v1/customers/{id}

Delete customer for the authenticated partner

Update Customer

PATCH <example>.com/reportApi/api/v1/customers/{id}

Update customer fields for the authenticated partner

List Customers

GET <example>.com/reportApi/api/v1/customers

Retrieve a list of customers for the authenticated partner

Create Customer

POST <example>.com/reportApi/api/v1/customers

Create customer for the authenticated partner

Register A Device

POST <example>.com/reportApi/api/v1/users/registerDevice/{deviceId}

Register a device