Autional Autional
API Reference GitHub autional.com →

GET /admin/webhooks/event-types/{event}/schema

Get description and example payload for a specified event type

Tenant Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
event path string Yes Event type name

Responses

StatusDescriptionSchema
200Event schemadto.EventSchemaDetailResponse
400Invalid request parametersgitee_com_linmes_authms_base_dto.SimpleResponse
401Unauthorizedgitee_com_linmes_authms_base_dto.SimpleResponse
403Insufficient permissionsgitee_com_linmes_authms_base_dto.SimpleResponse
404Resource not foundgitee_com_linmes_authms_base_dto.SimpleResponse
500Internal server errorgitee_com_linmes_authms_base_dto.SimpleResponse

Referenced Schemas

dto.EventSchemaDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.EventSchemaResponse No
message string No
timestamp string No

dto.EventSchemaResponse

FieldTypeRequiredExampleConstraintsDescription
action string No created
description string No Triggered when a new user is created
domain string No user
event_type string No user.created
example object No

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No