APIv1.WebhookResource interface

Webhooks allow you to tap into events within Core3D as they occur.

This interface was referenced by V1's JSON-Schema via the definition "WebhookResource".

Signature:

export interface WebhookResource 

Properties

Property

Modifiers

Type

Description

created_at

Date

when the resource was created

creator

UserIdentity

id

string

the resource id

is_active

boolean

whether the webhook is active

name

string

the webhook name

owner

TeamIdentity | UserIdentity

secret?

string

(Optional) The webhook secret. Please note that this will only appear once (in the creation response body).

types

(("account/create" | "account/delete" | "account/update" | "background/create" | "background/delete" | "background/update" | "design/create" | "design/delete" | "design/update" | "experimental/roblox/complete" | "export/complete" | "export/create" | "export/delete" | "export/update" | "invoice/create" | "invoice/update" | "generation/complete" | "generation/create" | "generation/delete" | "generation/update" | "material/create" | "material/delete" | "material/update" | "metafield/create" | "metafield/delete" | "metafield/update" | "metafield-definition/create" | "metafield-definition/delete" | "metafield-definition/update" | "model/create" | "model/delete" | "model/update" | "model-link/create" | "model-link/delete" | "model-link/update" | "placement/create" | "placement/delete" | "placement/update" | "team/create" | "team/delete" | "team/update" | "team-member/create" | "team-member/delete" | "team-member/update" | "token/create" | "token/delete" | "token/update" | "upload/create" | "upload/delete" | "upload/update" | "upload-variant/complete" | "upload-variant/create" | "upload-variant/delete" | "upload-variant/update" | "user/create" | "user/delete" | "user/update" | "webhook/create" | "webhook/delete" | "webhook/update") | "firehose")[]

the event types for which the webhook should be notified

updated_at

Date

when the resource was updated

uri

string

the resource uri

url

string

the webhook url

Get in touch

We'd love to learn more about your vision and how we can help.

PressPrivacyTermsSupportCopyright © 2025 Core3D, Inc. All Rights Reserved.