Get Your API Key

First register for free and get your API Key. Api Key is required for calling all web service methods.

Using the SOAP web service.

SOAP Web Service URL : http://api.eventtrigger.net/Services.asmx

Methods

RegisterEvent

Use thid method to register your event.

Input Parameter Data Type Description
APIKey string You can get it for free after registration and activating your account
EventTitle string Title of your event. We will pass it back during verification
CallBackUrl string This URL will be called at scheduled time.
FireDate DateTime The specified time when you want your event to be called
the date time should be in UTC format example:
2022-08-28 14:50
IsRecurring bool If you want your event to be called recurringly set it true
RecurringTime int the time to be rescheduled for recurring call
RecurringType byte it specifies the type of recurring time. If recurring time value is in minute set it 1. For example if you want your event to be called recurringly every 30 minutes set recurringtime to 30 and recurringtype to 1. other possible values for recurring type is as follow.
1 > minute
2 > hour
3 > day
4 > week
5 > month
6 > year
StopDate DateTime The specified time when you want your event to be stopped
the date time should be in UTC format example:
2022-08-28 14:50
OptionalParameters string optional Parameters. we will send it back dusing verification.

if the method result is positive it is the new registered EventID (int).
if the method result is zero it means that the provided ApiKey is invalid.
if the method result is negative it means that an unwanted error happened.

RemoveEvent

Use this method to remove a previously registered event.

Input Parameter Data Type Description
APIKey string You can get it for free after registration and activating your account
EventID int The ID of the event you want to remove.

if the method result is positive it is the registered Event has been removed.
if the method result is zero it means that the provided ApiKey is invalid.
if the method result is negative it means that an unwanted error happened.

VerifyCallBack

Use this method once you received our callback. For security reasons it is mandatory to call this method in recurring events. If you dont verify the callback, your event wont be set for the next recurring call.

Input Parameter Data Type Description
APIKey string You can get it for free after registration and activating your account
CallBackToken string Your CallBack url will be called at specified time and a parameter named Token will be passed to your Url using GET method. Your have to get this parameter and use it in verification method.

if the method result is not Zero or Negative value it will be a JSON serialized Object in the following format: { "EventID","EventTitle","Parameters" }
if the method result is zero it means that the provided ApiKey is invalid.
if the method result is negative it means that an unwanted error happened.



Using the REST web service.


Methods

RegisterEvent

Use thid method to register your event.
Web Service URL : http://api.eventtrigger.net/api/Services/RegisterEvent
JSON serialized data object:


{
   "APIKey" : string,
   "EventTitle" : string,
   "CallBackUrl" : string,
   "FireDate" : DateTime UTC,
   "IsRecurring" : bool,
   "RecurringTime" : int,
   "RecurringType" : byte,
   "StopDate" : DateTime UTC,
   "OptionalParameters" : string
}

if the method result is positive it is the new registered EventID (int).
if the method result is zero it means that the provided ApiKey is invalid.
if the method result is negative it means that an unwanted error happened.

RemoveEvent

Use this method to remove a previously registered event.
Web Service URL : http://api.eventtrigger.net/api/Services/RemoveEvent
JSON serialized data object:


{
   "APIKey" : string,
   "EventID" : int
}

if the method result is positive it is the registered Event has been removed.
if the method result is zero it means that the provided ApiKey is invalid.
if the method result is negative it means that an unwanted error happened.

VerifyCallBack

Use this method once you received our callback. For security reasons it is mandatory to call this method in recurring events. If you dont verify the callback, your event wont be set for the next recurring call.
Web Service URL : http://api.eventtrigger.net/api/Services/VerifyCallBack
JSON serialized data object:


{
   "APIKey" : string,
   "CallBackToken" : string
}

JSON serialized data result:

{
   "Status" : int,
   "DataObject" :
         {
         "EventID": int
         "EventTitle": string
         "Parameters": string
         }
}

if the Status value is positive value, the the DataObject will be provided otherwise the DataObject field will be null.
if the Status value is zero it means that the provided ApiKey is invalid.
if the Status value is negative it means that an unwanted error happened.