StravaPHP

The Strava\API\Webhook class provides static methods to handle the two main stages of webhook integration:

1. Subscription Challenge: When you first create a subscription, Strava sends a challenge to your endpoint. Use Webhook::handleSubscriptionChallenge($verifyToken) to extract the challenge and Webhook::sendChallengeResponse($challenge) to respond.
2. Event Processing: To process incoming activity or athlete updates, use Webhook::processEvent(). This returns an array containing a success boolean and either the event data or an error message.

Always return a 200 OK response to Strava upon successful processing to prevent repeated delivery attempts.

// Handle subscription challenge
$verifyToken = 'your_random_verify_token';
$challengeResult = Webhook::handleSubscriptionChallenge($verifyToken);

if ($challengeResult['success']) {
    Webhook::sendChallengeResponse($challengeResult['challenge']);
}

// Process incoming webhook events
$eventResult = Webhook::processEvent();

if ($eventResult['success']) {
    $event = $eventResult['event'];
    // ... process event ...
    http_response_code(200);
    echo json_encode(['status' => 'success']);
} else {
    http_response_code(400);
    echo json_encode(['error' => $eventResult['error']]);
}

The Strava\API\OAuth class manages the two-step OAuth process: redirecting the user to Strava for authorization and exchanging the resulting authorization code for an access token.

1. Authorization: Use getAuthorizationUrl() to generate a link where users can approve your application. You can specify required scopes (e.g., read, read_all, activity:read_all).
2. Token Exchange: After the user is redirected back to your redirectUri with a code in the query string, use getAccessToken() with the authorization_code grant type to retrieve the token.

use Strava\ÁPI\OAuth;
use Strava\API\Exception;

$options = [
    'clientId'     => 1234,
    'clientSecret' => 'APP-TOKEN',
    'redirectUri'  => 'http://my-app/callback.php'
];
$oauth = new OAuth($options);

if (!isset($_GET['code'])) {
    // Step 1: Redirect user to Strava
    $url = $oauth->getAuthorizationUrl([
        'scope' => ['read']
    ]);
    print '<a href="'.$url.'">Connect</a>';
} else {
    // Step 2: Exchange code for token
    $token = $oauth->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);
    print $token->getToken();
}

The Strava\API\Webhook class includes utility methods to easily inspect the contents of a webhook event payload:

• getEventType($event): Returns the string event type (e.g., activity.create).
• isObjectType($event, $type): Returns true if the event belongs to a specific object type like activity or athlete.
• isAspectType($event, $aspect): Returns true if the event represents a specific action like create, update, or delete.
• verifySignature($payload, $signature, $secret): Validates the webhook signature for security.

// Get event type (e.g., 'activity.create')
$eventType = Webhook::getEventType($event);

// Check if event is for specific object type
$isActivity = Webhook::isObjectType($event, 'activity');
$isAthlete = Webhook::isObjectType($event, 'athlete');

// Check if event is specific aspect type
$isCreate = Webhook::isAspectType($event, 'create');
$isUpdate = Webhook::isAspectType($event, 'update');
$isDelete = Webhook::isAspectType($event, 'delete');

// Verify webhook signature
$isValid = Webhook::verifySignature($payload, $signature, $secret);

Use the Strava\API\Client instance to manage your webhook subscriptions. You can create new subscriptions, list existing ones, and delete them using your Strava application credentials (clientId, clientSecret) and a callbackUrl and verifyToken of your choice.

To use these methods, you must first initialize a Client with a REST service and a Guzzle HTTP adapter.

// Create API client
$adapter = new GuzzleClient(['base_uri' => 'https://www.strava.com/api/v3/']);
$service = new REST('YOUR_ACCESS_TOKEN', $adapter);
$client = new Client($service);

$clientId = 12345;
$clientSecret = 'your_client_secret';
$callbackUrl = 'https://yourdomain.com/webhook-endpoint.php';
$verifyToken = 'your_random_verify_token';

try {
    // Create a webhook subscription
    $subscription = $client->createWebhookSubscription(
        $clientId,
        $clientSecret,
        $callbackUrl,
        $verifyToken
    );
    
    // List existing subscriptions
    $subscriptions = $client->listWebhookSubscriptions($clientId, $clientSecret);
    
    // Delete a subscription
    $client->deleteWebhookSubscription($clientId, $clientSecret, $subscription['id']);
    
} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . "\n";
}

The Strava\API\Client class provides methods to interact with various Strava resources. Below is a list of available methods for retrieving and managing data.

// Athlete methods
$client->getAthlete($id = null);
$client->getAthleteStats($id);
$client->getAthleteClubs();
$client->getAthleteRoutes($id, $type = null, $after = null, $page = null, $per_page = null);
$client->getAthleteActivities($before = null, $after = null, $page = null, $per_page = null);
$client->getAthleteFriends($id = null, $page = null, $per_page = null);
$client->getAthleteFollowers($id = null, $page = null, $per_page = null);
$client->getAthleteBothFollowing($id, $page = null, $per_page = null);
$client->getAthleteKom($id, $page = null, $per_page = null);
$client->getAthleteZones();
$client->getAthleteStarredSegments($id = null, $page = null, $per_page = null);
$client->updateAthlete($city, $state, $country, $sex, $weight);

// Activity methods
$client->getActivityFollowing($before = null, $page = null, $per_page = null); 
$client->getActivity($id, $include_all_efforts = null);
$client->getActivityComments($id, $markdown = null, $page = null, $per_page = null);
$client->getActivityKudos($id, $page = null, $per_page = null);
$client->getActivityPhotos($id, $size = 2048, $photo_sources = 'true');
$client->getActivityZones($id);
$client->getActivityLaps($id);
$client->getActivityUploadStatus($id);
$client->createActivity($name, $type, $start_date_local, $elapsed_time, $description = null, $distance = null);
$client->uploadActivity($file, $activity_type = null, $name = null, $description = null, $private = null, $commute = null, $trainer = null, $data_type = null, $external_id = null);
$client->updateActivity($id, $name = null, $type = null, $private = false, $commute = false, $trainer = false, $gear_id = null, $description = null);
$client->deleteActivity($id);

// Club, Route, Segment, and Stream methods
$client->getGear($id);
$client->getClub($id);
$client->getClubMembers($id, $page = null, $per_page = null);
$client->getClubActivities($id, $page = null, $per_page = null);
$client->getRoute($id);
$client->getRouteAsGPX($id);
$client->getRouteAsTCX($id);
$client->getSegment($id);
$client->getSegmentLeaderboard($id, $gender = null, $age_group = null, $weight_class = null, $following = null, $club_id = null, $date_range = null, $page = null, $per_page = null);
$client->getSegmentExplorer($bounds, $activity_type = 'riding', $min_cat = null, $max_cat = null);
$client->getSegmentEffort($id, $athlete_id = null, $start_date_local = null, $end_date_local = null, $page = null, $per_page = null);
$client->getStreamsActivity($id, $types, $resolution = null, $series_type = 'distance');
$client->getStreamsEffort($id, $types, $resolution = null, $series_type = 'distance');
$client->getStreamsSegment($id, $types, $resolution = null, $series_type = 'distance');
$client->getStreamsRoute($id);

// Webhook methods
$client->createWebhookSubscription($clientId, $clientSecret, $callbackUrl, $verifyToken);
$client->listWebhookSubscriptions($clientId, $clientSecret);
$client->deleteWebhookSubscription($clientId, $clientSecret, $subscriptionId);