OnboardRequest schema | Directwerk Docs

Skip to content

Directwerk Docs

Main Navigation

Guide
Install
Operators
Architecture
API

Appearance

Sidebar Navigation

article-controller

List articles
Create draft 1
Get article
Update draft 1
Archive 1
Cancel schedule 1
Replace categories 1
Publish 1
Schedule 1
Unarchive 1
Unpublish 1

auth-controller

Accept invite
Forgot password
Register
Reset password
Verify email

episode-controller

List episodes
Create draft
Get episode
Update draft
Archive
Attach audio
Cancel schedule
Replace categories
Set enclosure enabled
Replace formats
Publish
Schedule
Unarchive
Unpublish

me-article-controller

List articles 2

me-billing-controller

Create checkout session
Create portal session

me-controller

Me
Access
Subscriptions

me-downloads-controller

List downloads

me-episode-controller

List episodes 2
Stream episode

me-feed-controller

List feeds
Create custom feed
Update custom feed
Delete custom feed
Set feed enabled
Preview feed
Rotate feed token
Set default feed enabled
Rotate default token
Preview formats

me-notification-preferences-controller

Get preferences
Update preferences

media-controller

List 1
Get 1
Delete
Confirm
Preview url
Create upload url 1

module-probe-controller

Digital probe
Podcast probe

platform-admin-controller

List admins
Revoke admin
Invite admin

platform-audit-controller

List recent

platform-module-controller

List modules
Get tenant modules
Deactivate module
Activate module
Apply preset

platform-overview-controller

Get overview

platform-queue-controller

List
Enqueue
Get
Complete
Fail
Claim

platform-tenant-controller

List tenants
Create tenant
Get tenant
Update tenant
Force verify domain
Reactivate tenant
Suspend tenant

platform-tenant-media-controller

List media
Delete media
Confirm upload
Create upload url

platform-tenant-user-controller

List users 1
Update user role
Deactivate user 1
Reactivate user 1
Resend invite
Invite user 1

podcast-import-controller

Ingest asset
Get ingest asset
Import episode
Preview

public-altcha-controller

Challenge

public-article-controller

List articles 1
Get article 1

public-contact-controller

Submit

public-episode-download-controller

Download episode

public-level-controller

List levels

public-podcast-controller

List categories 1
List episodes 1
List formats 1
List series 1

public-site-config-controller

Site config

public-subscription-product-controller

List active products

rss-feed-controller

Public series feed
Public enclosure
Public podcast feed
Private subscriber feed
Private enclosure

security-probe-controller

Context
Editor probe
Platform probe
Subscriber probe
Tenant admin probe

series-controller

List series
Create series
Get series
Update series

stripe-webhook-controller

Handle

studio-auth-controller

Workspaces

tenant-admin-controller

Get branding
Update branding
List domains
Add domain
Get domain verification
Verify domain
List users
Deactivate user
Reactivate user
Invite user

tenant-billing-dashboard-controller

Dashboard

tenant-category-controller

List categories
Create category
Update category
Deactivate category

tenant-content-email-template-controller

Get template
Upsert template

tenant-format-controller

List formats
Create format
Update format
Deactivate format

tenant-stripe-controller

Onboard
Status

tenant-subscriber-controller

List subscribers

tenant-subscriber-feed-controller

List feeds 1
Set enabled

tenant-subscription-controller

Grant subscription
Revoke subscription

tenant-subscription-product-controller

List products
Create product
Update product
Deactivate product
List rules
Replace rules
Sync stripe

Schemas

AcceptInviteRequest
AcceptInviteResponse
AccessResponse
AddDomainRequest
AdminInvitationResponse
AnalyticsResponse
ArticleView
AttachAudioRequest
BillingDashboard
BillingStats
BrandingResponse
BrandingUpdateRequest
BrandingView
CategoryView
ChannelView
CheckoutSessionRequest
CheckoutSessionView
ClaimJobsRequest
CompleteJobRequest
ContactAcceptedResponse
ContactRequest
CreateArticleRequest
CreateCategoryRequest
CreateCustomFeedRequest
CreateEpisodeRequest
CreateFormatRequest
CreateProductRequest
CreateSeriesRequest
CreateTenantRequest
CreateUploadUrlRequest
DomainVerificationView
DomainView
DownloadView
EnclosureEnabledRequest
EnqueueJobRequest
EpisodePreviewView
EpisodeView
ErrorDetail
FailJobRequest
FeedEnabledRequest
FeedPreviewView
ForgotPasswordRequest
ForgotPasswordResponse
FormatView
GrantSubscriptionRequest
ImportEpisodeRequest
ImportedEpisodeView
IngestAssetRequest
InvitePlatformAdminRequest
InviteRequest
InviteTenantUserRequest
InviteUserResponse
JsonNode
LevelView
MeArticleView
MeEpisodeView
MeResponse
MediaAssetView
MembershipRow
ModuleAdoptionView
ModuleView
NotificationPreferencesView
OnboardRequest
OnboardView
PackageView
PlatformAdminInvitationResponse
PlatformAdminView
PlatformAuditView
PlatformOverviewView
PortalRequest
PreviewRequest
PreviewUrlResponse
PreviewView
ProbeResponse
ProductAccessRuleRequest
ProductAccessRuleView
ProductView
PublicArticleView
PublicCategoryView
PublicEpisodeView
PublicFormatView
PublicSeriesView
PublishOptionsRequest
QueueJob
RegisterRequest
RegisterResponse
ReplaceCategoriesRequest
ReplaceFormatsRequest
ReplaceRulesRequest
ResetPasswordRequest
ResponseAcceptInviteResponse
ResponseAccessResponse
ResponseArticleView
ResponseBillingDashboard
ResponseBrandingView
ResponseCategoryView
ResponseCheckoutSessionView
ResponseContactAcceptedResponse
ResponseDomainVerificationView
ResponseDomainView
ResponseEpisodeView
ResponseFeedPreviewView
ResponseForgotPasswordResponse
ResponseFormatView
ResponseImportedEpisodeView
ResponseInviteUserResponse
ResponseListArticleView
ResponseListCategoryView
ResponseListDomainView
ResponseListDownloadView
ResponseListEpisodeView
ResponseListFormatView
ResponseListLevelView
ResponseListMeArticleView
ResponseListMeEpisodeView
ResponseListMediaAssetView
ResponseListModuleView
ResponseListPlatformAdminView
ResponseListPlatformAuditView
ResponseListProductAccessRuleView
ResponseListProductView
ResponseListPublicArticleView
ResponseListPublicCategoryView
ResponseListPublicEpisodeView
ResponseListPublicFormatView
ResponseListPublicSeriesView
ResponseListQueueJob
ResponseListSeriesView
ResponseListSubscriberFeedAdminView
ResponseListSubscriberFeedView
ResponseListSubscriberView
ResponseListSubscriptionView
ResponseListUserView
ResponseMeResponse
ResponseMediaAssetView
ResponseNotificationPreferencesView
ResponseOnboardView
ResponsePlatformAdminInvitationResponse
ResponsePlatformAdminView
ResponsePlatformOverviewView
ResponsePreviewUrlResponse
ResponsePreviewView
ResponseProbeResponse
ResponseProductView
ResponsePublicArticleView
ResponseQueueJob
ResponseRegisterResponse
ResponseRoleProbeResponse
ResponseSecurityContextView
ResponseSeriesView
ResponseSiteConfigResponse
ResponseStripeStatusView
ResponseStudioWorkspacesResponse
ResponseSubscriberFeedAdminView
ResponseSubscriberFeedView
ResponseSubscriptionView
ResponseTemplateView
ResponseTenantCreationResponse
ResponseTenantDetailResponse
ResponseTenantDetailView
ResponseTenantListResponse
ResponseTenantMediaListResponse
ResponseTenantModulesView
ResponseTenantUserListResponse
ResponseTenantUserView
ResponseUploadUrlResponse
ResponseVerifyEmailResponse
ResponseVoid
RoleProbeResponse
ScheduleArticleRequest
ScheduleEpisodeRequest
SecurityContextView
SeriesView
SiteConfigResponse
StripeStatusSnapshot
StripeStatusView
StudioWorkspaceResponse
StudioWorkspacesRequest
StudioWorkspacesResponse
SubscriberFeedAdminView
SubscriberFeedView
SubscriberView
SubscriptionSummaryView
SubscriptionView
TemplateView
TenantCountSummary
TenantCreationResponse
TenantDetailResponse
TenantDetailView
TenantDomainView
TenantListItemView
TenantListResponse
TenantMediaListResponse
TenantModuleActivationView
TenantModulesView
TenantResponse
TenantUserListResponse
TenantUserView
UpdateArticleRequest
UpdateCategoryRequest
UpdateCustomFeedRequest
UpdateEpisodeRequest
UpdateFormatRequest
UpdateNotificationPreferencesRequest
UpdateProductRequest
UpdateSeriesRequest
UpdateTenantRequest
UpdateTenantUserRoleRequest
UploadUrlResponse
UpsertContentEmailTemplateRequest
UserView
VerifyEmailRequest
VerifyEmailResponse

Changelog

History

On this page

OnboardRequest object

Field	Type	Description
`returnUrl`	string
`refreshUrl`	string

Directwerk — whitelabel publication infrastructure