| Request Type | POST |
|---|---|
| Request URL | baseUrl + auth0/create-event |
| Required Fields : | |
| name | Event name(For notation only) |
| url | your url //without baseurl, baseurl already added when app created |
| executionTime | 2022-03-31T12:01:06Z //(YYYY-MM-DDThh:mm:ssZ)Time when you want to execute your event |
| Optional fields : | |
| requestType | ['POST', 'GET', 'DELETE', 'PUT'], // Deafult POST |
| authorization | Bearer token |
| data | String or Object |
| description | String //used only for your natation |
Please do not use ' ' or " " in required and optional fields values when create events using Postman.
Expected Output:{
"data": "Event created successfully",
"status": 1,
"eventId": "event-id"
}| Request Type | PUT |
|---|---|
| Request URL | baseUrl + auth0/update-event/eventId |
| Required Fields (Atleast one field is required) : | |
| name | Event name(For notation only) |
| url | your url //without baseurl, baseurl already added when app created |
| executionTime | 2022-03-31T12:01:06Z //(YYYY-MM-DDThh:mm:ssZ)Time when you want to execute your event |
| requestType | ['POST', 'GET', 'DELETE', 'PUT'], // Deafult POST |
| authorization | Bearer token |
| data | String or Object |
| description | String //used only for your natation |
Please do not use ' ' or " " in required and optional fields values when create events using Postman.
Expected Output:{
"data": "Changes Successfully",
"status": 1,
}| Request Type | GET |
|---|---|
| Request URL | baseUrl + auth0/get-events |
| Optional fields : payload in query parameter | |
| skip | skip number of records |
| limit | fetch number of records |
{
"status": 1, //on success 1 else 0
"response": { //response data
"_id": "appId",
"name": "App Name",
"description": "App description",
"status": true,
"baseUrl": "Your apps baseurl",
"urlToken": "token for execute events",
"events": [{}. {}, {}... //list of events ],
"appToken": "token for create, delete and view events"
}
}| Request Type | GET |
|---|---|
| Request URL | baseUrl + auth0/event-info/eventId |
{
"status": 1, //on success 1 else 0
"response": { //response data
"name": "App Name",
"status": true,
"baseUrl": "Your apps baseurl",
"eventDetails": {
"requestType": "GET",
"response": 2,
"_id": "event id",
"name": "Event Name",
"url": "event url",
"executionTime": "UTC timestamp",
"data": "if set",
"status": true
}
}| Request Type | DELETE |
|---|---|
| Request URL | baseUrl + auth0/delete-event/eventId |
{
"response": "Event deleted successfully",
"status": 1
}| Request Type | POST |
|---|---|
| Request URL | baseUrl + auth0/create-webhook |
| Required Fields : | |
| url | Webhook Url // full form of url start with http:// or https:// |
| type | Webhook Type // '1' for event_execution |
| Optional Fields : | |
| authorization | Bearer token |
{
"status": 1,
"data": "Webhook created successfully",
"webhookId": "webhook-id"
}Payload at webhook hit| eventId | Id of executed Event |
| status | 1 for success and 2 for failed |
| responseData | complete response of event execution |
| hmac | verify webhook hit using 'responseData' as public key and 'wk-api-token' as private key |
| Request Type | GET |
|---|---|
| Request URL | baseUrl + auth0/get-webhooks |
{
"status":1, //on sucess 1 else 0
"data":[ //response data
{
"_id": "Webhook Id"
"url": "Webhook Url"
"appId": "Registered AppId"
"type": "Webhook Type" // 1 for event_execution
"status": "Webhook Status" //true for active and false for Deactive
}
]
}| Request Type | DELETE |
|---|---|
| Request URL | baseUrl + auth0/delete-webhook/webhookId |
{
"data": "Webhook deleted successfully",
"status": 1
}