GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

WebHookSetup

GET /api/webhooks/setup

200 OK
WebHookCollectionItem

OK

type
WebHookCollectionItem
Response Example (200 OK) 
[
  {
    "Id": "string",
    "Description": "string",
    "WebHookId": "string",
    "Url": "string",
    "IsPaused": "boolean",
    "Actions": "string"
  }
]
WebHookSetup

POST /api/webhooks/setup

AddEditWebHookViewModel

undefined

Request Example
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string",
  "Description": "string",
  "Url": "string",
  "IsPaused": "boolean",
  "PayloadStyle": "string",
  "IgnoreWebhookValidation": "boolean"
}
200 OK
AddEditWebHookViewModel

OK

Response Example (200 OK) 
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string",
  "Description": "string",
  "Url": "string",
  "IsPaused": "boolean",
  "PayloadStyle": "string",
  "IgnoreWebhookValidation": "boolean"
}
WebHookSetup

DELETE /api/webhooks/setup/{webhookid}

webhookid: string
in path

(no description)

200 OK

OK

WebHookSetup

GET /api/webhooks/setup/{webhookid}/test

webhookid: string
in path

(no description)

200 OK
TestWebHookViewModel

OK

Response Example (200 OK) 
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string"
}
WebHookSetup

POST /api/webhooks/setup/{webhookid}/test

TestWebHookViewModel

undefined

webhookid: object
in path

(no description)

Request Example
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string"
}
200 OK

OK

WebHookSetup

GET /api/webhooks/setup/actiontypes/lookup

200 OK
GenericLookUpChoice<String>

OK

type
GenericLookUpChoice<String>
Response Example (200 OK) 
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
WebHookSetup

POST /api/webhooks/setup/add/realestate

200 OK

OK

WebHookSetup

GET /api/webhooks/setup/details/{webhookid}

webhookid: string
in path

(no description)

200 OK
AddEditWebHookViewModel

OK

Response Example (200 OK) 
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string",
  "Description": "string",
  "Url": "string",
  "IsPaused": "boolean",
  "PayloadStyle": "string",
  "IgnoreWebhookValidation": "boolean"
}

Schema Definitions

WebHookCollectionItem: object

Id: string
Description: string
WebHookId: string
Url: string
IsPaused: boolean
Actions: string
Example
{
  "Id": "string",
  "Description": "string",
  "WebHookId": "string",
  "Url": "string",
  "IsPaused": "boolean",
  "Actions": "string"
}

AddEditWebHookViewModel: object

Id: string
WebHookId: string
WebHookFilters: string
Description: string
Url: string
IsPaused: boolean
PayloadStyle: string
IgnoreWebhookValidation: boolean
Example
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string",
  "Description": "string",
  "Url": "string",
  "IsPaused": "boolean",
  "PayloadStyle": "string",
  "IgnoreWebhookValidation": "boolean"
}

Boolean: object

Example
"object"

GenericLookUpChoice<String>: object

Id: string
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "string",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

TestWebHookViewModel: object

Id: string
WebHookId: string
WebHookFilters: string
Example
{
  "Id": "string",
  "WebHookId": "string",
  "WebHookFilters": "string"
}

String: object

this[]: string
Length: integer
Example
{
  "this[]": "string",
  "Length": "integer"
}
Documentation by Spectacle