🪝 Add / Change / Remove Webhook

The addWebhook, changeWebhook, and removeWebhook mutations manage your college's webhook subscriptions. A subscription sends the selected events to your URL. To list existing subscriptions, use Get Webhooks; for event payloads, see Webhooks.

addWebhook

Creates a new webhook subscription for the selected events. Store the returned webhook id on your side — you need it to change or remove the subscription.

Input Parameters

Parameter	Type	Description
`events`	[WebhookEvent!]!	Events to subscribe to (see WebhookEvent Values below).
`url`	String!	Destination URL that receives the events.

Response Fields

Returns the created Webhook (see Related Types).

🚀 Request (Try It)

changeWebhook

Updates an existing webhook subscription — change the subscribed events, the destination URL, or both. Only the fields you provide are changed.

Input Parameters

Parameter	Type	Description
`id`	ID!	ID of the webhook subscription to update.
`events`	[WebhookEvent!]	New list of subscribed events (optional).
`url`	String	New destination URL (optional).

Response Fields

Returns the updated Webhook.

🚀 Request (Try It)

removeWebhook

Deletes an existing webhook subscription.

Input Parameters

Parameter	Type	Description
`id`	ID!	ID of the webhook subscription to remove.

Response Fields

Field	Type	Description
`success`	Boolean	Returns `true` if the subscription was removed.

🚀 Request (Try It)

Webhook

Field	Type	Description
`id`	ID!	Unique identifier of the webhook subscription.
`url`	String!	Destination URL that receives webhook events.
`events`	[WebhookEvent!]!	Events the subscription is subscribed to.
`created`	String!	Timestamp when the subscription was created.
`updated`	String!	Timestamp when the subscription was last updated.

WebhookEvent Values

REJECTED_RESOURCE, STUDENT_PASSED_COURSE, IMPORTED_ASSETS, DEGREE_STUDENT_ACTIVATED, DEGREE_STUDENT_COMPLETED_APPLICATION, DEGREE_STUDENT_ARCHIVED, DEGREE_STUDENT_DELISTED, DEGREE_STUDENT_COMPLETED, ACTIVITY_UPLOAD_FINISHED