Get One Webhook

GET

webhooks

{webhook_id}

Get One Webhook

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

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

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

	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/{webhook_id}")

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

{
  "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"
    }
  ]
}

{
  "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}.

Path Parameters

webhook_id

integer

required

integer - required - The ID of the webhook you want to get

Example:

1

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"

Response

Get Webhook

name

string

required

The name of the webhook.

Example:

"Sample Webhook"

url

string

required

The URL that data should be sent to.

Example:

"https://www.example.com/webhook"

trigger_object

enum<string>

required

The object that will cause the webhook to trigger.

Available options:

event,

contact,

registrant,

speaker,

sponsor,

session,

session_attendance,

registrant_line_item

Example:

"registrant"

group_id

integer

Identifier for the webhook group.

headers

object[]

Array of headers for the webhook.

Show child attributes

Example:

[
  {
    "key": "Authentication",
    "value": "Bearer Token"
  }
]

trigger_on_insert

boolean

Trigger the webhook when the object is inserted.

Example:

true

trigger_on_update

boolean

Trigger the webhook when the object is updated.

Example:

true

trigger_on_delete

boolean

Trigger the webhook when the object is deleted.

Example:

false

public_user

boolean

Run the webhook for public users.

Example:

false

admin_user

boolean

Run the webhook for admin users.

Example:

true

api_call

boolean

Trigger the webhook during an API call.

Example:

true

all_fields

boolean

Run the webhook for changes to all fields.

Example:

false

any_event

boolean

Run the webhook for any event.

Example:

false

use_default_fields

boolean

Use default fields for the webhook.

Example:

true

enabled

boolean

Indicates whether the webhook is enabled.

Example:

true

event_ids

integer[]

List of event IDs to trigger the webhook.

Example:

[1, 2, 3]

fields

object[]

Array of fields to trigger the webhook when changed.

Example:

["value"]

content_type

enum<string>

The content type for webhook payloads.

Available options:

json,

post

Example:

"json"

notes

string

Additional notes for the webhook.

Example:

"This webhook is for test purposes."

post_field_data

enum<string>[]

Fields to include in the webhook POST data.

Available options:

id,

value

Example:

["id", "value"]

custom_fields

object[]

Custom fields for the webhook (type unspecified).

Show child attributes

Example:

[
  {
    "key": "event_id",
    "type": "registrant",
    "value": "event_id"
  }
]

⌘I

Get One Webhook

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

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

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

	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/{webhook_id}")

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

{
  "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"
    }
  ]
}

{
  "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

Authorizations

Path Parameters

Query Parameters

Response