{"items":[{"type":"link","label":"Self-Service Webhooks API","link":"/apis/selfservicewebhooks","routeSlug":"/apis/selfservicewebhooks","content":{"contentType":"overview","meta":{"name":"Self-Service Webhooks API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"selfServiceWebhooks.json","url":"/_bundle/apis/selfServiceWebhooks.json?download"},{"kind":"download","label":"selfServiceWebhooks.yaml","url":"/_bundle/apis/selfServiceWebhooks.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Self-Service Webhooks API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Self-Service Webhooks API allows you to programmatically manage webhook subscriptions."},"children":[]}]}]}]}],"sectionId":"/apis/selfservicewebhooks"}],"sectionId":"/apis/selfservicewebhooks"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints require OAuth 2.0 Bearer token authentication. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/apis/oauth2.0"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details on obtaining access tokens."},"children":[]}]}]}]}],"sectionId":"/apis/selfservicewebhooks/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/supported-event-types"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported Event Types"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the following event type is supported for self-service webhook subscriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PdvRequestCompleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Triggered when a driver completes a Proactive Driver Verification request"},"children":[]}]}]}]}]}],"sectionId":"/apis/selfservicewebhooks/section/supported-event-types"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URLs must use HTTPS"},"children":[]}]}]}]}]}],"sectionId":"/apis/selfservicewebhooks/section/limits"}]}]}},{"type":"link","label":"Authentication","link":"/apis/selfservicewebhooks/section/authentication","routeSlug":"/apis/selfservicewebhooks/section/authentication","content":null},{"type":"link","label":"Supported Event Types","link":"/apis/selfservicewebhooks/section/supported-event-types","routeSlug":"/apis/selfservicewebhooks/section/supported-event-types","content":null},{"type":"link","label":"Limits","link":"/apis/selfservicewebhooks/section/limits","routeSlug":"/apis/selfservicewebhooks/section/limits","content":null},{"type":"group","label":"Webhooks","link":"/apis/selfservicewebhooks/webhooks","routeSlug":"/apis/selfservicewebhooks/webhooks","items":[{"label":"Create Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/createwebhook","routeSlug":"/apis/selfservicewebhooks/webhooks/createwebhook","metadata":{"seo":{"title":"Create Webhook","description":"Create a new webhook subscription for the specified event type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create Webhook","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new webhook subscription for the specified event type.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest"}},"schemaId":"components/schemas/CreateWebhookRequest","pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest"}},"responseCodes":["201","400","401","409","422"],"pointer":"/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"schemaId":"components/schemas/CreateWebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse","headers":{"Location":{"description":"URL of the created webhook resource","schema":{"type":"string","example":"/api/v1/webhooks/550e8400-e29b-41d4-a716-446655440000"}}},"headerSchemaId":"schema_279"},{"code":"400","description":"Bad request - Invalid request syntax","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"409","description":"Conflict - Webhook already exists for this event type and URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"409","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"List Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/listwebhooks","routeSlug":"/apis/selfservicewebhooks/webhooks/listwebhooks","metadata":{"seo":{"title":"List Webhooks","description":"Retrieve a paginated list of all webhook subscriptions for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List Webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of all webhook subscriptions for your account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"eventType","in":"query","schemaId":"schema_280","description":"Filter by event type"},{"name":"active","in":"query","schemaId":"schema_281","description":"Filter by active status"},{"name":"page","in":"query","schemaId":"schema_282","description":"Page number (starts at 1)"},{"name":"pageSize","in":"query","schemaId":"schema_283","description":"Number of items per page (max 100)"}],"pointer":"/paths/~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"eventType","in":"query","required":false,"example":"PdvRequestCompleted","schemaId":"schema_280"},{"name":"active","in":"query","required":false,"example":true,"schemaId":"schema_281"},{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_282"},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_283"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List Webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}},"schemaId":"components/schemas/WebhookListResponse"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookListResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Get Webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/getwebhook","routeSlug":"/apis/selfservicewebhooks/webhooks/getwebhook","metadata":{"seo":{"title":"Get Webhook","description":"Retrieve details of a specific webhook subscription by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Get Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific webhook subscription by ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_284","description":"Webhook UUID","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{uuid}","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_284"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/webhooks/{uuid}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Get Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhook"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"},{"label":"Update Webhook","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/updatewebhook","routeSlug":"/apis/selfservicewebhooks/webhooks/updatewebhook","metadata":{"seo":{"title":"Update Webhook","description":"Update an existing webhook subscription. Only provided fields will be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an existing webhook subscription. Only provided fields will be updated.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_284","description":"Webhook UUID","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"schemaId":"components/schemas/UpdateWebhookRequest","pointer":"/paths/~1webhooks~1{uuid}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/webhooks/{uuid}","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_284"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"responseCodes":["200","400","401","404","422"],"pointer":"/webhooks/{uuid}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"schemaId":"components/schemas/UpdateWebhookRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateWebhookRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}},"schemaId":"components/schemas/WebhookResponse"},{"code":"400","description":"Bad request - Invalid request syntax","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks~1{uuid}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"422","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"},{"label":"Delete Webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/deletewebhook","routeSlug":"/apis/selfservicewebhooks/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete Webhook","description":"Delete a webhook subscription. This action cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a webhook subscription. This action cannot be undone.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_284","description":"Webhook UUID","required":true}],"pointer":"/paths/~1webhooks~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/webhooks/{uuid}","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_284"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","401","404"],"pointer":"/webhooks/{uuid}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Webhook deleted successfully"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks~1{uuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}"},{"label":"Test Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/selfservicewebhooks/webhooks/testwebhook","routeSlug":"/apis/selfservicewebhooks/webhooks/testwebhook","metadata":{"seo":{"title":"Test Webhook","description":"Send a test payload to the webhook endpoint to verify connectivity and configuration.The test will send a sample event payload to your configured clientUrl."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testWebhook","name":"Test Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{uuid}~1test/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test Webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a test payload to the webhook endpoint to verify connectivity and configuration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The test will send a sample event payload to your configured "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_284","description":"Webhook UUID","required":true}],"pointer":"/paths/~1webhooks~1{uuid}~1test/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks/{uuid}/test","servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_284"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/webhooks/{uuid}/test","href":"webhooks/testwebhook","openApiOperationId":"testWebhook","summary":"Test Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/selfservicewebhooks","description":"Mock server","isMockServer":true},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test completed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestWebhookResponse"}},"schemaId":"components/schemas/TestWebhookResponse"},{"code":"401","description":"Unauthorized - Invalid or expired token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Webhook not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1webhooks~1{uuid}~1test/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TestWebhookResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TestWebhookResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/testwebhook"}],"panels":[]}]},"httpPath":"/webhooks/{uuid}/test"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Create Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/webhooks","summary":"List Webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Get Webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Update Webhook","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/webhooks/{uuid}","summary":"Delete Webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/webhooks/{uuid}/test","summary":"Test Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/testwebhook","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CreateWebhookRequest":{"id":"components/schemas/CreateWebhookRequest","kind":"json-schema","title":"CreateWebhookRequest","data":{"type":"object","required":["eventType","clientUrl"],"properties":{"eventType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of event to subscribe to. Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PdvRequestCompleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for self-service webhooks."},"children":[]}]}]}],"enum":["PdvRequestCompleted"],"example":"PdvRequestCompleted"},"clientUrl":{"type":"string","format":"uri","description":"The HTTPS URL where webhook payloads will be delivered. Must be a valid HTTPS URL.\n","example":"https://your-tms.example.com/webhooks/trucker-tools"}}}},"components/schemas/UpdateWebhookRequest":{"id":"components/schemas/UpdateWebhookRequest","kind":"json-schema","title":"UpdateWebhookRequest","data":{"type":"object","properties":{"clientUrl":{"type":"string","format":"uri","description":"The HTTPS URL where webhook payloads will be delivered.\n","example":"https://new-url.example.com/webhooks"},"eventType":{"type":"string","description":"The type of event to subscribe to.\n","enum":["PdvRequestCompleted"],"example":"PdvRequestCompleted"},"isActive":{"type":"boolean","description":"Whether the webhook is active and should receive events.\n","example":true}}}},"components/schemas/WebhookResponse":{"id":"components/schemas/WebhookResponse","kind":"json-schema","title":"WebhookResponse","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","description":"Unique identifier for the webhook","example":"550e8400-e29b-41d4-a716-446655440000"},"eventType":{"type":"string","description":"The event type this webhook subscribes to","example":"PdvRequestCompleted"},"clientUrl":{"type":"string","description":"The URL where webhook payloads are delivered","example":"https://your-tms.example.com/webhooks/trucker-tools"},"isActive":{"type":"boolean","description":"Whether the webhook is currently active","example":true},"createdAt":{"type":"string","format":"date-time","description":"When the webhook was created","example":"2024-05-24T19:50:18.053Z"}}}},"components/schemas/WebhookListResponse":{"id":"components/schemas/WebhookListResponse","kind":"json-schema","title":"WebhookListResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookResponse"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number","example":1},"pageSize":{"type":"integer","description":"Number of items per page","example":20},"totalPages":{"type":"integer","description":"Total number of pages","example":1},"totalCount":{"type":"integer","description":"Total number of webhooks","example":1}}}}}},"components/schemas/TestWebhookResponse":{"id":"components/schemas/TestWebhookResponse","kind":"json-schema","title":"TestWebhookResponse","data":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the test delivery was successful","example":true},"statusCode":{"type":"integer","description":"HTTP status code returned by your endpoint (present on success)","example":200},"error":{"type":"string","description":"Error message (present on failure)","example":"Could not reach the webhook endpoint."}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP status code","example":422},"errors":{"type":"array","items":{"type":"object","properties":{"appName":{"type":"string","description":"Application name","example":"loadtracking-api"},"dateTime":{"type":"string","format":"date-time","description":"When the error occurred","example":"2024-05-24T19:50:18.053Z"},"message":{"type":"string","description":"Human-readable error message","example":"Invalid eventType. Must be one of: PdvRequestCompleted"},"keyword":{"type":"string","description":"Error type keyword","example":"enum"},"params":{"type":"object","description":"Additional error parameters","properties":{"field":{"type":"string","example":"eventType"},"allowedValues":{"type":"array","items":{"type":"string"},"example":["PdvRequestCompleted"]}}}}}}}}},"components/schemas/PdvRequestCompletedPayload":{"id":"components/schemas/PdvRequestCompletedPayload","kind":"json-schema","title":"PdvRequestCompletedPayload","data":{"type":"object","description":"This is the payload that will be sent to your webhook endpoint when a Proactive Driver Verification request is completed.\n","properties":{"eventType":{"type":"string","description":"The event type","example":"PdvRequestCompleted"},"timestamp":{"type":"string","format":"date-time","description":"When the event occurred","example":"2024-05-24T19:50:18.053Z"},"data":{"type":"object","properties":{"requestId":{"type":"string","format":"uuid","description":"Unique identifier for the PDV request","example":"550e8400-e29b-41d4-a716-446655440000"},"loadNumber":{"type":"string","description":"The load number associated with this request","example":"LOAD123"},"driverPhoneNumber":{"type":"string","description":"The driver's phone number","example":"555-555-5555"},"response":{"type":"object","description":"The driver's response details","properties":{"address":{"type":"string","description":"Street address of driver's current location","example":"123 Destination St"},"city":{"type":"string","description":"City name","example":"Chicago"},"state":{"type":"string","description":"State or province code","example":"IL"},"country":{"type":"string","description":"Country code","example":"USA"},"postalCode":{"type":"string","description":"Postal or ZIP code","example":"60601"},"distanceMiles":{"type":"number","description":"Distance to destination in miles","example":150},"etaSeconds":{"type":"integer","description":"Estimated time of arrival in seconds","example":7200},"createdAt":{"type":"string","format":"date-time","description":"When the response was submitted","example":"2024-05-24T19:50:18.053Z"}}}}}}}},"schema_279":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","example":"/api/v1/webhooks/550e8400-e29b-41d4-a716-446655440000","description":"URL of the created webhook resource"}}},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"string","enum":["PdvRequestCompleted"],"example":"PdvRequestCompleted"},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1,"example":1},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":20,"example":20},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"id":"schema_284"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2.0 Bearer token"}},"servers":[{"url":"/_mock/apis/selfservicewebhooks","isMockServer":true,"description":"Mock server"},{"url":"https://loadtracking.truckertools.com/api/v1","description":"Production server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/selfservicewebhooks","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/selfServiceWebhooks.json?download"},{"url":"/_bundle/apis/selfServiceWebhooks.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Self-Service Webhooks API","description":"The Self-Service Webhooks API allows you to programmatically manage webhook subscriptions.\n\n## Authentication\nAll endpoints require OAuth 2.0 Bearer token authentication. See the [OAuth 2.0 documentation](/apis/oauth2.0.yaml) for details on obtaining access tokens.\n\n## Supported Event Types\nCurrently, the following event type is supported for self-service webhook subscriptions:\n- `PdvRequestCompleted` - Triggered when a driver completes a Proactive Driver Verification request\n\n## Limits\n- Webhook URLs must use HTTPS\n"}},"baseSlug":"/apis/selfservicewebhooks","routesMapping":{}}