Webhook Groups

Get All Webhook Groups

Retrieves all webhook groups. Webhook groups organize individual webhooks and control which events they apply to. A group is assigned to one or more events, and all webhooks within the group will fire for those events. This allows you to manage webhook configurations across multiple events centrally.

Available Fields

These are the standard fields available for configuring a webhook:

Name	Type	Description
`id`	integer	The ID of the webhook group.
`name`	string	The name of the webhook group.
`headers`	array	Defined headers for the group.
`notification_emails`	array	Emails notified when a webhook in the group fails.

Extra Fields

Additional information that can be returned by specifying the desired fields in the expand parameter:

Name	Type	Description
`webhooks`	object	List of webhooks associated with this group.

GET

webhook-groups

Get All Webhook Groups

curl --request GET \
  --url https://api.swoogo.com/api/v1/webhook-groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.swoogo.com/api/v1/webhook-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/webhook-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swoogo.com/api/v1/webhook-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.swoogo.com/api/v1/webhook-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "name": "Sample Webhook Group",
      "headers": [
        {
          "key": "Authentication",
          "value": "Bearer Token"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "notification_emails": [
        "notify@example.com",
        "test@example.com"
      ],
      "created_at": "2023-04-21 15:46:23",
      "updated_at": "2023-04-21 15:47:37"
    }
  ],
  "_links": {
    "self": {
      "href": ""
    },
    "first": {
      "href": ""
    },
    "last": {
      "href": ""
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401
}

{
  "name": "Forbidden",
  "message": "You do not have access to that resource.",
  "code": 0,
  "status": 403
}

{
  "name": "Not Found",
  "message": "The requested resource does not exist.",
  "code": 0,
  "status": 404
}

{
  "name": "Internal Server Error",
  "message": "An error occurred while processing your request.",
  "code": 0,
  "status": 500
}

Authorizations

Authorization

string

header

required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Query Parameters

fields

string

string - optional - Comma separated list of fields you want to return

Example:

"id,name,headers,notification_emails,created_at,created_by,updated_at,updated_by"

expand

string

string - optional - Comma separated list of objects you want to return

Example:

""

string

string - optional - Filter conditions to narrow the results. Valid operators are =, !=, >=, <=, >, <, contains, beginswith, endswith

Example:

"id>123"

page

string

integer - optional - The page of results you want to view

Example:

"1"

per-page

string

integer - optional - The number of results per page (to a max of 200)

Example:

"5"

sort

string

string - optional - Sort the results (add - in front for opposite sort direction, e.g. "-id")

ids

string

Comma-separated list of IDs to retrieve. When provided, only records matching these IDs are returned. All values must be positive integers. Maximum 100 IDs per request.

Response

Collection

items

object[]

Show child attributes

_links

object

Show child attributes

_meta

object

Show child attributes

⌘I

Get All Webhook Groups

curl --request GET \
  --url https://api.swoogo.com/api/v1/webhook-groups \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.swoogo.com/api/v1/webhook-groups', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.swoogo.com/api/v1/webhook-groups",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.swoogo.com/api/v1/webhook-groups"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.swoogo.com/api/v1/webhook-groups")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "name": "Sample Webhook Group",
      "headers": [
        {
          "key": "Authentication",
          "value": "Bearer Token"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "notification_emails": [
        "notify@example.com",
        "test@example.com"
      ],
      "created_at": "2023-04-21 15:46:23",
      "updated_at": "2023-04-21 15:47:37"
    }
  ],
  "_links": {
    "self": {
      "href": ""
    },
    "first": {
      "href": ""
    },
    "last": {
      "href": ""
    }
  },
  "_meta": {
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "perPage": 20
  }
}

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0,
  "status": 401
}

{
  "name": "Forbidden",
  "message": "You do not have access to that resource.",
  "code": 0,
  "status": 403
}

{
  "name": "Not Found",
  "message": "The requested resource does not exist.",
  "code": 0,
  "status": 404
}

{
  "name": "Internal Server Error",
  "message": "An error occurred while processing your request.",
  "code": 0,
  "status": 500
}

Overview

API endpoints

Get All Webhook Groups

Authorizations

Query Parameters

Response