Skip to main content

Webhook Event

Source: src/data/webhook-event/

Service

The webhook-event service is a stub (export {}). Not yet implemented.

Repository

WebhookEventRepository

MethodParametersReturns
getById(ctx: RequestContext, id: string)Promise<WebhookEventRecord | null>
listByTenant(ctx: RequestContext)Promise<WebhookEventRecord[]>
create(ctx: RequestContext, record: WebhookEventRecord)Promise<void>
update(ctx: RequestContext, id: string, patch: Partial<Omit<WebhookEventRecord, 'id' | 'tenantId'>>)Promise<WebhookEventRecord>
delete(ctx: RequestContext, id: string)Promise<void>

WebhookEventRecord

FieldType
idstring
tenantIdstring
createdAtDate
updatedAtDate
dataRecord<string, unknown> (optional)

Validators

webhookProviderSchema

Enum: PAYPAL, CASHAPP_PAY, COINBASE_COMMERCE, DISCORD

webhookEventSchema

FieldTypeRequiredDefault
tenantIdstringYes
providerwebhookProviderSchemaYes
eventIdstringYes
receivedAtDate (coerced)Yes
payloadunknownYes

Inferred Types

  • WebhookEventz.infer<typeof webhookEventSchema>
  • WebhookProviderz.infer<typeof webhookProviderSchema>