This article is historical and may not apply to current versions of Tally. For up-to-date information, visit the Tally page.
If you implement, or plan on implementing, Tally integration in your app, please drop us a line and let us know, we’d be happy to help. These schemes require Tally 2.0 or greater.
Tally supports for integration with other apps via the x-callback-url protocol. Tally registers the following URL scheme:
tally2://
x-callback-url Actions
/open
- Action: open
- Parameters:
- title [string, required] : Name of a tally. This tally must already exist in the app.
- Description: Opens app to the tally. If more than one tally have the same name, the first found will be used.
- Examples
- tally2://x-callback-url/open?title=Tally%20Name
/get
- Action: get
- Parameters:
- title [string, required] : Name of a tally to get. This tally must already exist in the app.
- retParam [string, optional] : If provided along with x-success parameter, this parameter will be used as the name of the "value" parameter appended to the callback.
- x-success [url, optional] : If provided, this URL will be fired after the tally is located and incremented successfully. URL will get "title" and "value" parameters added. "title" will match the incoming title parameter, and value will be the current value of the tally after the action was completed.
- x-error [url, optional] : If provided, this URL will be fired if Tally is unable to locate the Tally to increment.
- Description: When opened with this action, Tally will lookup the tally based on the title parameter, and call the x-success parameter URL with the current value of the tally added as a parameter.
- Examples
tally2://x-callback-url/get?title=Tally%20Name
/increment
- Action: increment
- Parameters:
- title [string, required] : Name of a tally to increment. This tally must already exist in the app.
- retParam [string, optional] : If provided along with x-success parameter, this parameter will be used as the name of the "value" parameter appended to the callback.
- x-success [url, optional] : If provided, this URL will be fired after the tally is located and incremented successfully. URL will get "title" and "value" parameters added. "title" will match the incoming title parameter, and value will be the current value of the tally after the action was completed.
- x-error [url, optional] : If provided, this URL will be fired if Tally is unable to locate the Tally to increment.
- Description: When opened with this action, Tally will lookup the tally based on the title parameter, and increment it. Increment will be based on the configuration of the tally – so if it is set to step by 5, the increment will be by five.
- Examples
tally2://x-callback-url/increment?title=Tally%20Name
/decrement
- Action: decrement
- Parameters:
- title [string, required] : Name of a tally to increment. This tally must already exist in the app.
- retParam [string, optional] : If provided along with x-success parameter, this parameter will be used as the name of the "value" parameter appended to the callback.
- x-success [url, optional] : If provided, this URL will be fired after the tally is located and incremented successfully. URL will get "title" and "value" parameters added. "title" will match the incoming title parameter, and value will be the current value of the tally after the action was completed.
- x-error [url, optional] : If provided, this URL will be fired if Tally is unable to locate the Tally to increment.
- Description: When opened with this action, Tally will lookup the tally based on the title parameter, and decrement it. Decrement will be based on the configuration of the tally – so if it is set to step by 5, the decrement will be by five.
- Examples
tally2://x-callback-url/decrement?title=Tally%20Name
Comments
0 comments
Please sign in to leave a comment.