Skip to content
Scenario Docs
Get started
API Reference
Projects
Webhook Endpoints

Events

List
projects.webhook_endpoints.events.list(strwebhook_endpoint_id, EventListParams**kwargs) -> EventListResponse
GET/projects/{projectId}/webhook-endpoints/{webhookEndpointId}/events
Retrieve
projects.webhook_endpoints.events.retrieve(strevent_id, EventRetrieveParams**kwargs) -> EventRetrieveResponse
GET/projects/{projectId}/webhook-endpoints/{webhookEndpointId}/events/{eventId}
ModelsExpand Collapse
class EventListResponse: …
items: List[Item]

A list of the project webhook events

id: str
endpoint_id: str
status: Literal["created", "failed", "retrying", "success"]
One of the following:
"created"
"failed"
"retrying"
"success"
type: Literal["*", "asset.download.completed", "asset.download.created", 16 more]

Every event a webhook endpoint can subscribe to: a project endpoint takes the job lifecycle events, a team endpoint takes the alert events.

One of the following:
"*"
"asset.download.completed"
"asset.download.created"
"asset.download.failed"
"generation.completed"
"generation.created"
"generation.failed"
"inference.cancelled"
"inference.completed"
"inference.created"
"inference.failed"
"model.download.completed"
"model.download.created"
"model.download.failed"
"model.training.cancelled"
"model.training.completed"
"model.training.failed"
"model.training.started"
"team.credit.threshold.crossed"
updated_at: str
next_pagination_token: Optional[str]

A token to query the next page of events

class EventRetrieveResponse: …
webhook_event: WebhookEvent
id: str
attempts: List[WebhookEventAttempt]
response_status_code: float
sent_at: str
created_at: str
endpoint_id: str
payload: object
sent_at: str
status: Literal["created", "failed", "retrying", "success"]
One of the following:
"created"
"failed"
"retrying"
"success"
type: Literal["*", "asset.download.completed", "asset.download.created", 16 more]

Every event a webhook endpoint can subscribe to: a project endpoint takes the job lifecycle events, a team endpoint takes the alert events.

One of the following:
"*"
"asset.download.completed"
"asset.download.created"
"asset.download.failed"
"generation.completed"
"generation.created"
"generation.failed"
"inference.cancelled"
"inference.completed"
"inference.created"
"inference.failed"
"model.download.completed"
"model.download.created"
"model.download.failed"
"model.training.cancelled"
"model.training.completed"
"model.training.failed"
"model.training.started"
"team.credit.threshold.crossed"
updated_at: str