Activity REST API routes

BuddyPress activities inform about actions and interactions of the community site’s members. Members can share public announcements and react about these by commenting or favoriting them. Activities also log events generated by the other BuddyPress components, for instance, when two users become friends.

[!IMPORTANT] The Activity component is an optional one. This means the activity endpoints will only be available if the component is active on the community site.

Schema

The schema defines all the fields that exist for an activity object.

List Activities

Arguments

Definition

GET /buddypress/v2/activity

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity?context=view&type=activity_update', {
	method: 'GET',
	headers: requestHeaders,
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.table( data );
} );

JSON Response

• An array of objects representing the matching activity items on success.
• An object containg the error code, data and message on failure.

Create an activity item

Logged in users can create sitewide activity items. When the Groups component is active, only group members can create activity items within the corresponding group.

Arguments

Definition

POST /buddypress/v2/activity

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity', {
	method: 'POST',
	headers: requestHeaders,
	body: JSON.stringify(
		{
			content: 'bapuu is the BuddyPress wapuu',
		}
	),
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.log( data );
} );

JSON Response

• An object representing the created activity item on success.
• An object containg the error code, data and message on failure.

Retrieve a specific activity item

Arguments

Definition

GET /buddypress/v2/activity/<id>

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity/18', {
	method: 'GET',
	headers: requestHeaders,
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.log( data );
} );

JSON Response

• An object representing the activity item on success.
• An object containg the error code, data and message on failure.

Update a specific activity item

Arguments

Definition

PUT /buddypress/v2/activity/<id>

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity/18', {
	method: 'PUT',
	headers: requestHeaders,
	body: JSON.stringify(
		{
			content: 'bapuu, The BP wapuu.',
			type: 'activity_update',
		}
	),
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.log( data );
} );

JSON Response

• An object representing the updated activity item on success.
• An object containg the error code, data and message on failure.

Delete a specific activity item

Arguments

Definition

DELETE /buddypress/v2/activity/<id>

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity/18', {
	method: 'DELETE',
	headers: requestHeaders,
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.log( data );
} );

JSON Response

• An object informing about the deleted status and the previous activity item on success.
• An object containg the error code, data and message on failure.

Add or remove a specific activity item from favorited activities

NB: the same endpoint is used to favorite and unfavorite an activity item. In case the activity is already favorited, it will remove this activity item from favorite activities.

Arguments

Definition

POST /buddypress/v2/activity/<id>/favorite

Example of use

[!WARNING] The requestHeaders object needs to be set according to the WordPress REST API nonce. Read more about the REST API authentification.

fetch( '/wp-json/buddypress/v2/activity/17/favorite', {
	method: 'POST',
	headers: requestHeaders,
} ).then( ( response ) => {
	return response.json();
} ).then( ( data ) => {
	 console.log( data );
} );

JSON Response

• An object representing the activity item on success.
• An object containg the error code, data and message on failure.

[^1]: This property is only available if the WordPress discussion settings allow avatars.