Difference between revisions of "Simple Groups API/set http callback"

Revision as of 11:31, 22 February 2022

Set HTTP callback to be called on group events.

The following table shows input values (you send them with the API call) and returned output values.

Variable		Required	Description
Input base:
	action	yes	= invite
	apikey	yes	Your personal developer's API key.
	secret	yes	Security code of the group you are using.
	secret_sha1	optional	The same as "secret" but hashed using SHA1 (useful if you don't want to keep plain customer's passwords)
Input:
	email	yes	the customer's email at SmartBots
	group	yes	the group name (must be listed with SmartBots!)
	app_name	yes	The application name (provided by developer, visible to the user)
	app_uuid	yes	The application UUID (provided by developer, not visible)
	url	yes	The URL to be called on group events
Output (JSON formatted):
	OK		command completed successfully
	anything else		Request failed, the fail reason is returned

This API call required information both from developer of an application (which received the callback) and from a customer.

The developer should provide the following data:

@@ Line 7: / Line 7: @@
 {{API Variable Group|Input}}
-{{API Variable|apikey|yes}} [https://www.mysmartbots.com/dev/docs/HTTP_API/Developer%27s_API_key Developer's API key] of the callback URL owner (see comments below)
 {{API Variable|email|yes}} the customer's email at SmartBots
 {{API Variable|group|yes}} the group '''name''' (must be listed with SmartBots!)
-{{API Variable|secret_sha1|yes}} The SHA1 hash of the [http://www.mysmartbots.com/docs/Security_code Group Security Code]
 {{API Variable|app_name|yes}} The application name (provided by developer, visible to the user)
 {{API Variable|app_uuid|yes}} The application UUID (provided by developer, not visible)