{"note":"OpenAPI conversion -- returning structured metadata","name":"apideck-com-webhook","description":"Webhook API","version":"10.24.14","base_url":"https://unify.apideck.com","endpoints":10,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Webhook API\n@base https://unify.apideck.com\n@version 10.24.14\n@auth ApiKey Authorization in header\n@endpoints 10\n@toc webhook(10)\n\n@endpoint GET /webhook/webhooks\n@desc List webhook subscriptions\n@required {x-apideck-app-id: str # The ID of your Unify application}\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20}\n@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?} # Webhooks\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /webhook/webhooks\n@desc Create webhook subscription\n@required {x-apideck-app-id: str # The ID of your Unify application, 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) # Name of Apideck Unified API, status: str(enabled/disabled) # The status of the webhook., delivery_url: str(uri) # The delivery url of the webhook endpoint., events: [str] # The list of subscribed events for this webhook. [`*`] indicates that all events are enabled.}\n@optional {description: str # A description of the object.}\n@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?} # Webhooks\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /webhook/webhooks/{id}\n@desc Get webhook subscription\n@required {id: str # JWT Webhook token that represents the unifiedApi and applicationId associated to the event source., x-apideck-app-id: str # The ID of your Unify application}\n@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?} # Webhooks\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /webhook/webhooks/{id}\n@desc Update webhook subscription\n@required {id: str # JWT Webhook token that represents the unifiedApi and applicationId associated to the event source., x-apideck-app-id: str # The ID of your Unify application}\n@optional {description: str # A description of the object., status: str(enabled/disabled) # The status of the webhook., delivery_url: str(uri) # The delivery url of the webhook endpoint., events: [str] # The list of subscribed events for this webhook. [`*`] indicates that all events are enabled.}\n@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?} # Webhooks\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /webhook/webhooks/{id}\n@desc Delete webhook subscription\n@required {id: str # JWT Webhook token that represents the unifiedApi and applicationId associated to the event source., x-apideck-app-id: str # The ID of your Unify application}\n@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?} # Webhooks\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /webhook/webhooks/{id}/execute/{serviceId}\n@desc Execute a webhook\n@required {id: str # JWT Webhook token that represents the unifiedApi and applicationId associated to the event source., serviceId: str # Service provider ID.}\n@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str} # Execute Webhook\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /webhook/webhooks/{id}/x/{serviceId}\n@desc Execute a webhook\n@required {id: str # JWT Webhook token that represents the unifiedApi and applicationId associated to the event source., serviceId: str # Service provider ID.}\n@optional {l_id: str # Unique identifier to used to look up consumer/connection when receiving connector events from downstream., e: str # The name of downstream event when connector does not supply in body or header}\n@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str} # Execute Webhook\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /webhook/w/{id}/{serviceId}\n@desc Resolve and Execute a connection webhook\n@required {id: str # JWT Webhook token that represents the connection lookupId. Signed so we know source came from us, serviceId: str # Service provider ID.}\n@optional {e: str # The name of downstream event when connector does not supply in body or header, validationToken: str # Validation token for webhook verification}\n@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str, _raw: map?} # Resolve Webhook\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /webhook/w/{id}/{serviceId}\n@desc Resolve and Execute a connection webhook\n@required {id: str # JWT Webhook token that represents the connection lookupId. Signed so we know source came from us, serviceId: str # Service provider ID.}\n@optional {e: str # The name of downstream event when connector does not supply in body or header}\n@returns(200) {status_code: int, status: str, data: map{timestamp: str, request_id: str}, request_id: str, timestamp: str, _raw: map?} # Resolve Webhook\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /webhook/logs\n@desc List event logs\n@required {x-apideck-app-id: str # The ID of your Unify application}\n@optional {cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, filter: map # Filter results}\n@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?} # EventLogs\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@end\n"}