Skip to content

Commit af56137

Browse files
committed
Adds webhook payload definitions
Adds webhook payload definitions
1 parent 3c78f0f commit af56137

File tree

2 files changed

+2128
-0
lines changed

2 files changed

+2128
-0
lines changed

types/onfleet__node-onfleet/Resources/Webhooks.d.ts

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,157 @@ declare namespace Webhook {
5555
| { triggerId: 12; triggerName: WebhookTriggerName.TaskDelayed }
5656
| { triggerId: 13; triggerName: WebhookTriggerName.TaskCloned }
5757
| { triggerId: 14; triggerName: WebhookTriggerName.SmsRecipientResponseMissed };
58+
59+
namespace Payload {
60+
interface ActionContext {
61+
id: string;
62+
type: string;
63+
apiKeyScopeId?: string | undefined;
64+
}
65+
66+
interface WebhookPayload {
67+
actionContext: ActionContext | null;
68+
adminId: string | null;
69+
taskId: string | null;
70+
time: number;
71+
triggerId: number;
72+
triggerName: string;
73+
workerId: string | null;
74+
}
75+
76+
interface TaskCreatedPayload extends WebhookPayload {
77+
data: {
78+
task: { [key: string]: unknown }
79+
};
80+
}
81+
82+
interface TaskUpdatedPayload extends WebhookPayload {
83+
data: {
84+
task: { [key: string]: unknown }
85+
worker?: { [key: string]: unknown } | undefined
86+
};
87+
}
88+
89+
interface TaskClonedPayload extends WebhookPayload {
90+
data: {
91+
task: { [key: string]: unknown }
92+
};
93+
}
94+
95+
interface TaskAssignedPayload extends WebhookPayload {
96+
data: {
97+
task: { [key: string]: unknown }
98+
worker: { [key: string]: unknown }
99+
};
100+
}
101+
102+
interface TaskUnassignedPayload extends WebhookPayload {
103+
data: {
104+
task: { [key: string]: unknown }
105+
};
106+
}
107+
108+
interface TaskDeletedPayload extends WebhookPayload {
109+
data: {
110+
task: { [key: string]: unknown }
111+
};
112+
}
113+
114+
interface TaskStartedPayload extends WebhookPayload {
115+
data: {
116+
task: { [key: string]: unknown }
117+
};
118+
}
119+
120+
interface TaskFailedPayload extends WebhookPayload {
121+
data: {
122+
task: { [key: string]: unknown }
123+
};
124+
}
125+
126+
interface TaskCompletedPayload extends WebhookPayload {
127+
data: {
128+
task: { [key: string]: unknown }
129+
};
130+
}
131+
132+
interface TaskDelayedPayload extends WebhookPayload {
133+
data: {
134+
task: { [key: string]: unknown }
135+
};
136+
delay: number;
137+
}
138+
139+
interface TaskETAPayload extends WebhookPayload {
140+
data: {
141+
task: { [key: string]: unknown }
142+
};
143+
etaSeconds: number;
144+
}
145+
146+
interface TaskArrivalPayload extends WebhookPayload {
147+
data: {
148+
task: { [key: string]: unknown }
149+
};
150+
distance: number;
151+
}
152+
153+
interface WorkerCreatedPayload extends WebhookPayload {
154+
data: {
155+
worker: { [key: string]: unknown };
156+
};
157+
}
158+
159+
interface WorkerDeletedPayload extends WebhookPayload {
160+
data: {
161+
worker: { [key: string]: unknown };
162+
};
163+
}
164+
165+
interface WorkerDutyPayload extends WebhookPayload {
166+
data: {
167+
worker: { [key: string]: unknown };
168+
};
169+
status: number;
170+
}
171+
172+
interface SMSRecipientOptOutPayload extends WebhookPayload {
173+
recipient: {
174+
id: string;
175+
name: string;
176+
phone: string;
177+
};
178+
timestamp: number;
179+
SMS: string;
180+
data: {};
181+
}
182+
183+
interface AutoDispatchJobCompletedPayload extends WebhookPayload {
184+
data: {
185+
dispatch: { [key: string]: unknown };
186+
}
187+
dispatchId: string;
188+
}
189+
190+
interface TaskBatchCreateJobCompletedPayload extends WebhookPayload {
191+
jobId: string;
192+
status: string;
193+
tasksReceived: number;
194+
tasksCreated: number;
195+
tasksErrored: number;
196+
errors: Array<{
197+
statusCode: number;
198+
errorCode: number;
199+
message: string;
200+
cause: string;
201+
taskData: { [key: string]: unknown };
202+
}>
203+
failedTasks: Array<{ [key: string]: unknown }>;
204+
newTasks: Array<{ [key: string]: unknown }>;
205+
newTasksWithWarnings: Array<{ [key: string]: unknown }>;
206+
data: {};
207+
}
208+
}
58209
}
59210

60211
export = Webhook;

0 commit comments

Comments
 (0)