@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Webhook API
@base https://unify.apideck.com
@version 10.24.14
@auth ApiKey Authorization in header
@endpoints 10
@toc webhook(10)

@endpoint GET /webhook/webhooks
@required {x-apideck-app-id: str}
@optional {cursor: str, limit: int=20}
@returns(200) {status_code: int, status: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint POST /webhook/webhooks
@required {x-apideck-app-id: str, unified_api: str(accounting/ats/calendar/crm/csp/customer-support/ecommerce/email/email-marketing/expense-management/file-storage/form/hris/lead/payroll/pos/procurement/project-management/script/sms/spreadsheet/team-messaging/issue-tracking/time-registration/transactional-email/vault/data-warehouse), status: str(enabled/disabled), delivery_url: str(uri), events: [str]}
@optional {description: str}
@returns(201) {status_code: int, status: str, data: map{id: str, description: str?, unified_api: str, status: str, disabled_reason: str, delivery_url: str(uri), execute_base_url: str(uri), events: [str], updated_at: str(date-time)?, created_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /webhook/webhooks/{id}
@required {id: str, x-apideck-app-id: str}
@returns(200) {status_code: int, status: str, data: map{id: str, description: str?, unified_api: str, status: str, disabled_reason: str, delivery_url: str(uri), execute_base_url: str(uri), events: [str], updated_at: str(date-time)?, created_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint PATCH /webhook/webhooks/{id}
@required {id: str, x-apideck-app-id: str}
@optional {description: str, status: str(enabled/disabled), delivery_url: str(uri), events: [str]}
@returns(200) {status_code: int, status: str, data: map{id: str, description: str?, unified_api: str, status: str, disabled_reason: str, delivery_url: str(uri), execute_base_url: str(uri), events: [str], updated_at: str(date-time)?, created_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint DELETE /webhook/webhooks/{id}
@required {id: str, x-apideck-app-id: str}
@returns(200) {status_code: int, status: str, data: map{id: str, description: str?, unified_api: str, status: str, disabled_reason: str, delivery_url: str(uri), execute_base_url: str(uri), events: [str], updated_at: str(date-time)?, created_at: str(date-time)?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint POST /webhook/webhooks/{id}/execute/{serviceId}
@required {id: str, serviceId: str}
@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str}
@errors {400, 401, 402, 404, 422}

@endpoint POST /webhook/webhooks/{id}/x/{serviceId}
@required {id: str, serviceId: str}
@optional {l_id: str, e: str}
@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str}
@errors {400, 401, 402, 404, 422}

@endpoint POST /webhook/w/{id}/{serviceId}
@required {id: str, serviceId: str}
@optional {e: str, validationToken: str}
@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /webhook/w/{id}/{serviceId}
@required {id: str, serviceId: str}
@optional {e: str}
@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str, _raw: map?}
@errors {400, 401, 402, 404, 422}

@endpoint GET /webhook/logs
@required {x-apideck-app-id: str}
@optional {cursor: str, limit: int=20, filter: map}
@returns(200) {status_code: int, status: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}, _raw: map?}
@errors {400, 401, 402, 404, 422}

@end
