Skip to content

Webhooks

The Webhooks API provides a mechanism for subscribing to events that occur within the Firstup platform to receive http payloads when those events occur. Use webhook subscriptions to trigger actions on your own application.

Webhook events are sent by the Firstup platform as POST requests to your webhook url. Each event contains a payload specific to that event. More information about the webhooks system, including a list of events that can be subscribed to, is available on the Webhooks page

Operations

Fetch the program's configured webhook subscriptions

Request

Fetchs multiple subscription records at a time, and can be paginated using cursor pagination.

Security
oauth2_as_a_user(Required scopes: webhooks.read) or oauth2_as_a_server(Required scopes: webhooks.read)
Query
page.sizeinteger, (int64)

Return page.size number of records starting at size*number. The default page size is 10 (number of records per page), resulting in the first page being retrieved. The maximum page size is 100.

page.numberinteger, (int64)

Using classical pagination, the page number to return. Default is 1

curl -i -X GET \
  'https://partner.socialchorus.com/v2/webhooks/subscriptions?page.size=0&page.number=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(Webhooks.Subscription.Resource)required
metaobject
Response
{
  "data": [
    { … }
  ],
  "meta": {
    "pagination": { … }
  }
}