Skip to content

Adds webhook payload definitions #69993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 1 commit into from
Jul 23, 2024
Merged

Adds webhook payload definitions #69993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
151 changes: 151 additions & 0 deletions types/onfleet__node-onfleet/Resources/Webhooks.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,157 @@ declare namespace Webhook {
| { triggerId: 12; triggerName: WebhookTriggerName.TaskDelayed }
| { triggerId: 13; triggerName: WebhookTriggerName.TaskCloned }
| { triggerId: 14; triggerName: WebhookTriggerName.SmsRecipientResponseMissed };

namespace Payload {
interface ActionContext {
id: string;
type: string;
apiKeyScopeId?: string | undefined;
}

interface WebhookPayload {
actionContext: ActionContext | null;
adminId: string | null;
taskId: string | null;
time: number;
triggerId: number;
triggerName: string;
workerId: string | null;
}

interface TaskCreatedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskUpdatedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
worker?: { [key: string]: unknown } | undefined
};
}

interface TaskClonedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskAssignedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
worker: { [key: string]: unknown }
};
}

interface TaskUnassignedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskDeletedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskStartedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskFailedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskCompletedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
}

interface TaskDelayedPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
delay: number;
}

interface TaskETAPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
etaSeconds: number;
}

interface TaskArrivalPayload extends WebhookPayload {
data: {
task: { [key: string]: unknown }
};
distance: number;
}

interface WorkerCreatedPayload extends WebhookPayload {
data: {
worker: { [key: string]: unknown };
};
}

interface WorkerDeletedPayload extends WebhookPayload {
data: {
worker: { [key: string]: unknown };
};
}

interface WorkerDutyPayload extends WebhookPayload {
data: {
worker: { [key: string]: unknown };
};
status: number;
}

interface SMSRecipientOptOutPayload extends WebhookPayload {
recipient: {
id: string;
name: string;
phone: string;
};
timestamp: number;
SMS: string;
data: {};
}

interface AutoDispatchJobCompletedPayload extends WebhookPayload {
data: {
dispatch: { [key: string]: unknown };
}
dispatchId: string;
}

interface TaskBatchCreateJobCompletedPayload extends WebhookPayload {
jobId: string;
status: string;
tasksReceived: number;
tasksCreated: number;
tasksErrored: number;
errors: Array<{
statusCode: number;
errorCode: number;
message: string;
cause: string;
taskData: { [key: string]: unknown };
}>
failedTasks: Array<{ [key: string]: unknown }>;
newTasks: Array<{ [key: string]: unknown }>;
newTasksWithWarnings: Array<{ [key: string]: unknown }>;
data: {};
}
}
}

export = Webhook;
Loading