Skip to content

Returns the paginated list of inbound webhooks, and on the first page also the spaces and courses available as enrolment targets.

The courses key is only present when the course_module feature is enabled. Pass search to filter by webhook title.

Endpoint

  • Method: GET

  • Path: /admin/webhooks

  • Edition: PRO

  • Controller: ProAdminController@getWebhooks

  • Route source: fluent-community-pro/app/Http/Routes/api.php:50

  • Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

  • Requires the FluentCommunity community-admin permission (or a WordPress super admin).

  • Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET List Webhooks

GET
/admin/webhooks

Returns the paginated list of inbound webhooks, and on the first page also the spaces and courses available as enrolment targets.

Controller: ProAdminController@getWebhooks
Route source: fluent-community-pro/app/Http/Routes/api.php:50

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Parameters

Query Parameters

search

Search read via $request->getSafe() in getWebhooks().

Type
string
page

Page read via $request->get() in getWebhooks().

Type
string

Responses

Successful response

application/json
JSON
{
  
"courses": [
  
  
{
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"course_details": "string",
  
  
  
  
"course_layout": "string",
  
  
  
  
"course_type": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"disable_comments": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_instructor_view": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"public_lesson_view": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"sequential_lesson_order": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_instructor_students_count": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"title": "string"
  
  
}
  
],
  
"spaces": [
  
  
{
  
  
  
"id": 0,
  
  
  
"logo": "string",
  
  
  
"settings": {
  
  
  
  
"can_request_join": "string",
  
  
  
  
"custom_lock_screen": "string",
  
  
  
  
"default_comment_sort_by": "string",
  
  
  
  
"default_post_sort_by": "string",
  
  
  
  
"disable_layout_style": "string",
  
  
  
  
"disable_post_sort_by": "string",
  
  
  
  
"document_access": "string",
  
  
  
  
"document_library": "string",
  
  
  
  
"document_upload": "string",
  
  
  
  
"emoji": "string",
  
  
  
  
"hide_members_count": "string",
  
  
  
  
"layout_style": "string",
  
  
  
  
"links": [
  
  
  
  
  
{
  
  
  
  
  
  
"additionalProperties": "string"
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"media_access": "string",
  
  
  
  
"media_gallery": "string",
  
  
  
  
"members_page_status": "string",
  
  
  
  
"og_image": "string",
  
  
  
  
"onboard_redirect_url": "string",
  
  
  
  
"restricted_post_only": "string",
  
  
  
  
"shape_svg": "string",
  
  
  
  
"show_paywalls": "string",
  
  
  
  
"show_sidebar": "string",
  
  
  
  
"topic_required": "string"
  
  
  
},
  
  
  
"slug": "string",
  
  
  
"title": "string"
  
  
}
  
],
  
"webhooks": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"additionalProperties": "string"
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": "string",
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": "string",
  
  
"total": 0
  
}
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation