Webhook

Defined in: v1/schemas.ts:747

A single webhook registered on the Teachable school.

Remarks

Important behavioural notes observed from the live API:

• Deleted webhooks are not filtered out — the /webhooks endpoint returns all webhooks regardless of their state, including ones that have been deleted. There is no way to distinguish a deleted webhook from an inactive one via this API.

• workflow_state values — observed values are failed, pending, and verified. Note that verified does not necessarily mean the webhook is active or published — it only indicates the endpoint URL was successfully verified at some point.

• webhook_events_count — represents the total number of times this webhook has been triggered, across its entire lifetime.

• Read-only — there are no POST or PATCH endpoints for webhooks in the Teachable v1 API. Webhooks can only be managed through the Teachable dashboard.

Extends

• output<typeof WebhookSchema>

Properties

event_trigger?

optional event_trigger?: string

Defined in: v1/schemas.ts:723

Inherited from

z.infer.event_trigger

---

id

id: number

Defined in: v1/schemas.ts:720

Inherited from

z.infer.id

---

url?

optional url?: string

Defined in: v1/schemas.ts:722

Inherited from

z.infer.url

---

webhook_events_count?

optional webhook_events_count?: number

Defined in: v1/schemas.ts:724

Inherited from

z.infer.webhook_events_count

---

workflow_state?

optional workflow_state?: string

Defined in: v1/schemas.ts:721

Inherited from

z.infer.workflow_state