javastrava.service.WebhookService Maven / Gradle / Ivy
Show all versions of javastrava-api Show documentation
package javastrava.service;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import javastrava.model.webhook.StravaEventSubscription;
/**
*
* API implementation of the Strava webhook events API
*
*
*
* Webhook push subscriptions allow an application to subscribe to events that occur within Strava’s infrastructure. These events are pushed to a URL designated by the subscription. Webhooks allow an
* application to update athletes in real-time, and implement smarter data fetching.
*
*
*
* Requests to the subscription endpoint are made using the client_id and client_secret of the application because requests are made on behalf of an application.
*
*
*
* This API is only available to select applications. To request access please contact [email protected]
*
*
* @see http://strava.github.io/api/partner/v3/events/
*
* @author Dan Shannon
*/
public interface WebhookService extends StravaService {
/**
*
* Creates a subscription to an allowed event
*
*
*
* The application must have permission to make use of the webhook API. Access can be requested by contacting developers -at- strava.com.
*
*
*
* The above request will send a GET request to callback url to verify existence
*
*
*
* Your response to this GET request must contain the hub.challenge token, ie. 15f7d1a91c1f40f8a748fd134752feb3 and have a response code of 200.
*
*
*
* On callback verification we respond to the original POST with the created subscription. If there is an error, a response containing the reason for failure will be returned.
*
*
*
* When an event occurs that corresponds to a push subscription, a POST request will be made to the callback url defined in the subscription. The payload will contain the object and aspect types
* affected, as well as information about the object and its owner if applicable.
*
*
*
* You should acknowledge the POST within a 2 second timeout–if you need to do more processing of the received information, you can do so in an asynchronous task.
*
*
*
* Additional metadata about the object is not included, and an application must decide how or if it wants to fetch updated data. For example, you may decide only to fetch new data for specific
* users, or after a certain number of activities have been uploaded.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @param subscription
* The subscription to create on Strava
* @param verifyToken
* The verification token Strava should use when validating your endpoint
* @return Details as stored on Strava
*/
public StravaEventSubscription createSubscription(Integer clientId, String clientSecret, StravaEventSubscription subscription, String verifyToken);
/**
*
* Creates a subscription to an allowed event
*
*
*
* The application must have permission to make use of the webhook API. Access can be requested by contacting developers -at- strava.com.
*
*
*
* The above request will send a GET request to callback url to verify existence
*
*
*
* Your response to this GET request must contain the hub.challenge token, ie. 15f7d1a91c1f40f8a748fd134752feb3 and have a response code of 200.
*
*
*
* On callback verification Strava responds to the original POST with the created subscription. If there is an error, a response containing the reason for failure will be returned.
*
*
*
* When an event occurs that corresponds to a push subscription, a POST request will be made to the callback url defined in the subscription. The payload will contain the object and aspect types
* affected, as well as information about the object and its owner if applicable.
*
*
*
* You should acknowledge the POST within a 2 second timeout–if you need to do more processing of the received information, you can do so in an asynchronous task.
*
*
*
* Additional metadata about the object is not included, and an application must decide how or if it wants to fetch updated data. For example, you may decide only to fetch new data for specific
* users, or after a certain number of activities have been uploaded.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @param subscription
* The subscription to create on Strava
* @param verifyToken
* The verification token Strava should use when validating your endpoint
* @return Details as stored on Strava
*/
public CompletableFuture createSubscriptionAsync(Integer clientId, String clientSecret, StravaEventSubscription subscription, String verifyToken);
/**
*
* This request is used to unsubscribe from events.
*
*
*
* If the delete is successful, a 204 will be returned. Otherwise, an error will be returned containing the reason for a failure.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @param id
* Unique identifier of the subscription to be deleted
*/
public void deleteSubscription(Integer clientId, String clientSecret, Integer id);
/**
*
* This request is used to unsubscribe from events.
*
*
*
* If the delete is successful, a 204 will be returned. Otherwise, an error will be returned containing the reason for a failure.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @param id
* Unique identifier of the subscription to be deleted
* @return Future to call get() on when ready
*/
public CompletableFuture deleteSubscriptionAsync(Integer clientId, String clientSecret, Integer id);
/**
*
* This request is used to retrieve the summary representations of the subscriptions in place for the current application.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @return List of current subscriptions for this application
*/
public List listSubscriptions(Integer clientId, String clientSecret);
/**
*
* This request is used to retrieve the summary representations of the subscriptions in place for the current application.
*
*
* @param clientId
* The application's client id (see https://www.strava.com/settings/api)
* @param clientSecret
* The application's client secret (see https://www.strava.com/settings/api)
* @return List of current subscriptions for this application
*/
public CompletableFuture> listSubscriptionsAsync(Integer clientId, String clientSecret);
}