Webhooks

Get All Webhooks

Retrieves all webhook configurations. Webhooks send HTTP POST callbacks to your specified URL when events occur in Swoogo (e.g., new registration, session check-in, payment received). Each webhook defines the target URL, trigger event type, and which webhook group it belongs to.

Available Fields

These are the standard fields available for configuring a webhook:

Name	Type	Description
`id`	integer	The ID of the webhook.
`name`	string	The name of the webhook.
`url`	string	The URL that data should be sent to.
`trigger_object`	string	The object that will cause the webhook to run.
`trigger_on_insert`	boolean	Trigger when the object is inserted.
`trigger_on_update`	boolean	Trigger when the object is updated.
`trigger_on_delete`	boolean	Trigger when the object is deleted.
`fields`	array	Array of fields which, when changed, will cause the webhook to run.
`public_user`	boolean	Run the webhook for a public user.
`admin_user`	boolean	Run the webhook for an admin user.
`api_call`	boolean	Run the webhook on an API call.
`any_event`	boolean	Run the webhook for any events (only applicable for some objects such as registrants).
`event_ids`	array	Array of event IDs to run the webhook for (if `any_event` is false).
`all_fields`	boolean	Should this run for changes to all fields?

Extra Fields

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

Name	Type	Description
`group`	object	Details about the Webhook Group associated with the item.

GET

webhooks

Get All Webhooks

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

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

fetch('https://api.swoogo.com/api/v1/webhooks', 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/webhooks",
  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/webhooks"

	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/webhooks")

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",
      "url": "https://www.example.com/webhook",
      "trigger_object": "registrant",
      "group_id": 123,
      "headers": [
        {
          "key": "Authentication",
          "value": "Bearer Token"
        }
      ],
      "trigger_on_insert": true,
      "trigger_on_update": true,
      "trigger_on_delete": false,
      "public_user": false,
      "admin_user": true,
      "api_call": true,
      "all_fields": false,
      "any_event": false,
      "use_default_fields": true,
      "enabled": true,
      "event_ids": [
        1,
        2,
        3
      ],
      "fields": [
        "value"
      ],
      "content_type": "json",
      "notes": "This webhook is for test purposes.",
      "post_field_data": [
        "id",
        "value"
      ],
      "custom_fields": [
        {
          "key": "event_id",
          "type": "registrant",
          "value": "event_id"
        }
      ]
    }
  ],
  "_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,url,content_type,post_field_data,use_default_fields,custom_fields,notes,trigger_object,trigger_on_insert,trigger_on_update,trigger_on_delete,all_fields,fields,public_user,admin_user,api_call,any_event,event_ids,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 Webhooks

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

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

fetch('https://api.swoogo.com/api/v1/webhooks', 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/webhooks",
  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/webhooks"

	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/webhooks")

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",
      "url": "https://www.example.com/webhook",
      "trigger_object": "registrant",
      "group_id": 123,
      "headers": [
        {
          "key": "Authentication",
          "value": "Bearer Token"
        }
      ],
      "trigger_on_insert": true,
      "trigger_on_update": true,
      "trigger_on_delete": false,
      "public_user": false,
      "admin_user": true,
      "api_call": true,
      "all_fields": false,
      "any_event": false,
      "use_default_fields": true,
      "enabled": true,
      "event_ids": [
        1,
        2,
        3
      ],
      "fields": [
        "value"
      ],
      "content_type": "json",
      "notes": "This webhook is for test purposes.",
      "post_field_data": [
        "id",
        "value"
      ],
      "custom_fields": [
        {
          "key": "event_id",
          "type": "registrant",
          "value": "event_id"
        }
      ]
    }
  ],
  "_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 Webhooks

Authorizations

Query Parameters

Response