Manage webhook subscriptions

Use the following API mutations to create, update, and remove webhook subscriptions.

Add webhook

addWebhook(
  events: [WebhookEvent!]!
  url: String!
): Webhook

Creates a new webhook subscription for the selected events.

Change webhook

changeWebhook(
  events: [WebhookEvent!]
  id: ID!
  url: String
): Webhook

Updates an existing webhook subscription.

Use this to:

• change subscribed events

• change the destination URL

Remove webhook

removeWebhook(id: ID!): Boolean

Deletes an existing webhook subscription.

List current webhook subscriptions

webhooks(pagination: Pagination = {skip: 0, take: 200}): WebhookPaginationResult!

Returns the list of webhook subscriptions currently configured for the college.

This is useful if you want to:

• check whether a webhook already exists

• review current subscribed events

• avoid creating duplicate subscriptions

Recommended webhook setup flow

1. Create a webhook subscription using addWebhook

2. Store the returned webhook ID on your side

3. Use changeWebhook if the URL or events need to change

4. Use webhooks(...) to review active subscriptions

5. Use removeWebhook if the subscription is no longer needed