Gantrel webhook events
Each delivery is { id, event, createdAt, data } signed with x-gantrel-signature. The id is stable across retries and replays. How to verify a signature: events reference guide.
Members
member.joinedMember joinedSomeone accepted an invitation or joined with an invite link.
Fields in data
| Field | Type | Description |
|---|---|---|
id | string | User id |
email | string | Email address |
role | string | Role key in this workspace |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "member.joined",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"id": "66f1a2b3c4d5e6f708192a3b",
"email": "maya@brightpad.test",
"role": "member"
}
}JSON schema of data
{
"type": "object",
"required": [
"id",
"email",
"role"
],
"properties": {
"id": {
"type": "string",
"description": "User id"
},
"email": {
"type": "string",
"description": "Email address"
},
"role": {
"type": "string",
"description": "Role key in this workspace"
}
}
}Billing
subscription.updatedSubscription updatedThe workspace started a plan or changed its plan or interval.
Fields in data
| Field | Type | Description |
|---|---|---|
planKey | string | Plan key |
interval | string | month or year |
status | string | Subscription status after the change |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "subscription.updated",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"planKey": "team",
"interval": "month",
"status": "active"
}
}JSON schema of data
{
"type": "object",
"required": [
"planKey",
"interval",
"status"
],
"properties": {
"planKey": {
"type": "string",
"description": "Plan key"
},
"interval": {
"type": "string",
"description": "month or year"
},
"status": {
"type": "string",
"description": "Subscription status after the change"
}
}
}subscription.canceledSubscription canceledThe subscription was canceled (immediately or at the end of the period).
Fields in data
| Field | Type | Description |
|---|---|---|
atPeriodEnd | boolean | True when access continues until the period ends |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "subscription.canceled",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"atPeriodEnd": true
}
}JSON schema of data
{
"type": "object",
"required": [
"atPeriodEnd"
],
"properties": {
"atPeriodEnd": {
"type": "boolean",
"description": "True when access continues until the period ends"
}
}
}invoice.paidInvoice paidAn invoice was paid, by a customer or by an automatic retry.
Fields in data
| Field | Type | Description |
|---|---|---|
id | string | Invoice id |
number | string | Invoice number |
total | number | Total in minor units (cents) |
currency | string | ISO 4217 code |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "invoice.paid",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"id": "66f1a2b3c4d5e6f708192a3c",
"number": "INV-2026-0042",
"total": 1900,
"currency": "USD"
}
}JSON schema of data
{
"type": "object",
"required": [
"id",
"number",
"total",
"currency"
],
"properties": {
"id": {
"type": "string",
"description": "Invoice id"
},
"number": {
"type": "string",
"description": "Invoice number"
},
"total": {
"type": "number",
"description": "Total in minor units (cents)"
},
"currency": {
"type": "string",
"description": "ISO 4217 code"
}
}
}credit.issuedCredit note issuedA credit note or partial refund was issued against an invoice.
Fields in data
| Field | Type | Description |
|---|---|---|
id | string | Credit note id |
number | string | Credit note number |
invoice | string | Invoice number it applies to |
amount | number | Amount in minor units |
method | string | refund or credit |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "credit.issued",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"id": "66f1a2b3c4d5e6f708192a3d",
"number": "CN-2026-0003",
"invoice": "INV-2026-0042",
"amount": 500,
"method": "credit"
}
}JSON schema of data
{
"type": "object",
"required": [
"id",
"number",
"invoice",
"amount",
"method"
],
"properties": {
"id": {
"type": "string",
"description": "Credit note id"
},
"number": {
"type": "string",
"description": "Credit note number"
},
"invoice": {
"type": "string",
"description": "Invoice number it applies to"
},
"amount": {
"type": "number",
"description": "Amount in minor units"
},
"method": {
"type": "string",
"description": "refund or credit"
}
}
}Files
file.uploadedFile uploadedA file was added to the workspace.
Fields in data
| Field | Type | Description |
|---|---|---|
id | string | File id |
name | string | File name |
size | number | Size in bytes |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "file.uploaded",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"id": "66f1a2b3c4d5e6f708192a3e",
"name": "roadmap.pdf",
"size": 482113
}
}JSON schema of data
{
"type": "object",
"required": [
"id",
"name",
"size"
],
"properties": {
"id": {
"type": "string",
"description": "File id"
},
"name": {
"type": "string",
"description": "File name"
},
"size": {
"type": "number",
"description": "Size in bytes"
}
}
}Notes
note.createdNote createdA note was created (example module).
Fields in data
| Field | Type | Description |
|---|---|---|
id | string | Note id |
title | string | Title |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "note.created",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"id": "66f1a2b3c4d5e6f708192a3f",
"title": "Launch checklist"
}
}JSON schema of data
{
"type": "object",
"required": [
"id",
"title"
],
"properties": {
"id": {
"type": "string",
"description": "Note id"
},
"title": {
"type": "string",
"description": "Title"
}
}
}System
webhook.testTest eventSent when you press "Send test event". Not part of any real activity.
Fields in data
| Field | Type | Description |
|---|---|---|
hello | string | Always "world" |
Sample payload
{
"id": "evt_8f3k2m9x1q7w",
"event": "webhook.test",
"createdAt": "2026-11-20T09:30:00.000Z",
"data": {
"hello": "world"
}
}JSON schema of data
{
"type": "object",
"required": [
"hello"
],
"properties": {
"hello": {
"type": "string",
"description": "Always \"world\""
}
}
}