Get One Webhook

get https://api.swoogo.com/api/v1/webhooks/{webhook_id}

Webhooks

This endpoint returns one object containing its details based on the object id.

Responses

Response body

object

name

string

required

The name of the webhook.

url

string

required

The URL that data should be sent to.

trigger_object

string

required

The object that will cause the webhook to trigger.

event contact registrant speaker sponsor session session_attendance registrant_line_item

group_id

integer

Identifier for the webhook group.

headers

array of objects

Array of headers for the webhook.

headers

object

key

string

Header key.

value

string

Header value.

trigger_on_insert

boolean

Trigger the webhook when the object is inserted.

trigger_on_update

boolean

Trigger the webhook when the object is updated.

trigger_on_delete

boolean

Trigger the webhook when the object is deleted.

public_user

boolean

Run the webhook for public users.

admin_user

boolean

Run the webhook for admin users.

api_call

boolean

Trigger the webhook during an API call.

all_fields

boolean

Run the webhook for changes to all fields.

any_event

boolean

Run the webhook for any event.

use_default_fields

boolean

Use default fields for the webhook.

enabled

boolean

Indicates whether the webhook is enabled.

event_ids

array of integers

List of event IDs to trigger the webhook.

event_ids

fields

array of objects

Array of fields to trigger the webhook when changed.

fields

object

content_type

string

The content type for webhook payloads.

json post

notes

string

Additional notes for the webhook.

post_field_data

array of strings

Fields to include in the webhook POST data.

post_field_data

custom_fields

array of objects

Custom fields for the webhook (type unspecified).

custom_fields

object

key

string

Key to identify value on response.

type

string

The object that will cause the webhook to trigger.

event contact registrant speaker sponsor session session_attendance registrant_line_item

value

string

Field name.

Headers

object

Cache-Control

string

Connection

string

Content-Length

string

Date

string

Expires

string

Keep-Alive

string

Link

string

Pragma

string

Server

string

Set-Cookie

string

X-Debug-Duration

string

X-Debug-Link

string

X-Debug-Tag

string

X-Pagination-Current-Page

string

X-Pagination-Page-Count

string

X-Pagination-Per-Page

string

X-Pagination-Total-Count

string

X-Rate-Limit-Limit

string

X-Rate-Limit-Remaining

string

X-Rate-Limit-Reset

string

Language

Credentials

Bearer

access_token

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.swoogo.com/api/v1/webhooks/webhook_id \
3
     --header 'accept: application/json'


xxxxxxxxxx
43
}
1
{
2
  "name": "Sample Webhook",
3
  "url": "https://www.example.com/webhook",
4
  "trigger_object": "registrant",
5
  "group_id": 0,
6
  "headers": [
7
    {
8
      "key": "Authentication",
9
      "value": "Bearer Token"
10
    }
11
  ],
12
  "trigger_on_insert": true,
13
  "trigger_on_update": true,
14
  "trigger_on_delete": false,
15
  "public_user": false,
16
  "admin_user": true,
17
  "api_call": true,
18
  "all_fields": false,
19
  "any_event": false,
20
  "use_default_fields": true,
21
  "enabled": true,
22
  "event_ids": [
23
    1,
24
    2,
25
    3

200Get Webhook

401Your request was made with invalid credentials.

403You do not have access to that resource.

404The requested resource does not exist.

500An error occurred while processing your request.