SOAP API method Account_callback

Back to API references

Description
Return a single Callback by ID or url. A callback is launched when a profile or subprofile is created, updated or deleted and the javascript expression of the callback matches.

Parameters
Parameter 'identifier' : int
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'callback' : Structure of type 'callback'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'callback'
This structure callback was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the callback.
Property 'url' : string
The url to notify.
Property 'method' : string
Get the method of notify. This can be xml, json.
Property 'expression' : string
The expression that validates the callback.
Property 'api_disabled' : boolean
Set whether the callback is disabled in api mode
Property 'actionfilter' : string
The actions that can trigger this callback.