Join Group Request Object

Attributes
siteMemberIdstringRead-onlyformat GUID
Member ID. See Members API for more details.

statusstring
6 supported values:
UNKNOWN_STATUSPENDINGAPPROVEDREJECTEDCANCELLEDCANCELED
Join group request status.
  • PENDING - Pending join group request.
  • APPROVED - Approved join group request.
  • REJECTED - Rejected join group request.
  • CANCELED - Canceled join group request.

requestDetailsobject
Join group request details.
Was this helpful?
Yes
No

GetList Join Group Requests

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 join group requests, given the provided paging. Group managers always have access to this functionality (site members can access their own join group requests in the site).

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/social-groups/v2/groups/{groupId}/join-requests

Was this helpful?
Yes
No

PostApprove Join Group Requests

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Approves pending join group requests. Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/{groupId}/join-requests/approve

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostReject Join Group Requests

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Rejects pending join group requests. Group managers always have access to this functionality. In some cases, site owners will allow group members to use this functionality as well.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/{groupId}/join-requests/reject

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostQuery Join Group Requests

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 join group requests, given the provided paging and filtering. Group managers always have access to this functionality (site members can access their own join group requests in the site).

Supported fields for filtering:

  • status

No supported fields for sorting

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Social Groups
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/social-groups/v2/groups/{groupId}/join-requests/query

Was this helpful?
Yes
No

Join Group Request Approved

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a join group request is approved by a group admin or a groups manager.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.social_groups.v2.join_group_request.

slugstring
Event name. Expected approved.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No

Join Group Request Rejected

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a join group request is rejected by a group admin or a groups manager.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.social_groups.v2.join_group_request.

slugstring
Event name. Expected rejected.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.
Was this helpful?
Yes
No