Egnyte MSP Webhooks Receiver specification (1.0.0)

Download OpenAPI specification:Download

Introduction

Webhook Receiver endpoint accepts POST requests with contents of a MSP event.

(re)Transmission policy

If sending a webhook call fails due to network issues or Receiver responds with a status other than 200 the request will be retried in the next schedule.

Permanent delivery failure despite multiple retries is counted. Multiple permanent delivery failures will result in the webhook being disabled.

Webhook receiver

Endpoint registered as a webhook URL in Egnyte MSP Public API

Note how incoming body data field schemas vary depending on event type.

Your server implementation should return HTTP status code 200 if the data was received and should not be retransmitted.
Non 200 status codes will schedule a retransmission and eventually cause the webhook to be disabled.

Request Body schema: application/json
One of
event_type
required
string
Default: "RESELLER_LINK_NFR_MANUALLY"
reseller_code
required
string

The Unique alpha numeric code used to identify the Reseller. This code is also present on the Reseller Dashboard.

first_name
required
string

First Name of the Reseller provided in the Reseller Dashboard

last_name
required
string

Last Name of the Reseller provided in the Reseller Dashboard

email
required
string

Reseller account's primary email

company_name
required
string

Company Name of the Reseller provided in the Reseller Dashboard

transaction_timestamp
required
string

Date time in ISO 8601 format

event_created_by
required
string

Name of the user who created the event

is_event_by_staff_user
required
boolean

Identifies whether the event is created by an Egnyte Staff

nfr_domain_name
required
string

Name of the NFR(Not For Resale) domain linked to the Reseller

nfr_plan
required
string

Name of the Plan deployed on the NFR domain

power_users
required
integer

Number of Power Users offered in the NFR domain

storage
required
integer

Amount of Storage offered in the NFR domain

Responses

Request samples

Content type
application/json
No sample