{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/dev-tools:apideck-webhook/event-logs-all":{"get":{"operationId":"dev_tools_apideck_webhook_event_logs_all","summary":"List event logs","description":"GET /webhook/logs","tags":["dev-tools"],"parameters":[{"name":"x-apideck-app-id","in":"query","required":true,"description":"The ID of your Unify application","schema":{"type":"string","description":"The ID of your Unify application"},"example":"dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"},{"name":"cursor","in":"query","required":false,"description":"Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.","schema":{"type":"string","description":"Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response."}},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Minimum 1, Maximum 200, Default 20","schema":{"type":"integer","default":20,"description":"Number of results to return. Minimum 1, Maximum 200, Default 20"}},{"name":"filter","in":"query","required":false,"description":"Filter results","schema":{"type":"object","description":"Filter results"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhook-verify":{"get":{"operationId":"dev_tools_apideck_webhook_webhook_verify","summary":"Resolve and Execute a connection webhook","description":"GET /webhook/w/{id}/{serviceId}","tags":["dev-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"JWT Webhook token that represents the connection lookupId. Signed so we know source came from us","schema":{"type":"string","description":"JWT Webhook token that represents the connection lookupId. Signed so we know source came from us"},"example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijk2MDAwYzIzLWI1NmItNGRlOC1iZmEzLTMxNTAzMTE3YzBmNyJ9.rAXnsmZ4O7eF0aDwdflkxAJQwMUfWs5989WfmspNZ6Q"},{"name":"serviceId","in":"query","required":true,"description":"Service provider ID.","schema":{"type":"string","description":"Service provider ID."},"example":"factorialhr"},{"name":"e","in":"query","required":false,"description":"The name of downstream event when connector does not supply in body or header","schema":{"type":"string","description":"The name of downstream event when connector does not supply in body or header"},"example":"Employees::Events::EmployeeCreated"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-resolve":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_resolve","summary":"Resolve and Execute a connection webhook","description":"POST /webhook/w/{id}/{serviceId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","serviceId","body"],"properties":{"id":{"type":"string","description":"JWT Webhook token that represents the connection lookupId. Signed so we know source came from us"},"serviceId":{"type":"string","description":"Service provider ID."},"e":{"type":"string","description":"The name of downstream event when connector does not supply in body or header"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-all":{"get":{"operationId":"dev_tools_apideck_webhook_webhooks_all","summary":"List webhook subscriptions","description":"GET /webhook/webhooks","tags":["dev-tools"],"parameters":[{"name":"x-apideck-app-id","in":"query","required":true,"description":"The ID of your Unify application","schema":{"type":"string","description":"The ID of your Unify application"},"example":"dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"},{"name":"cursor","in":"query","required":false,"description":"Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.","schema":{"type":"string","description":"Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response."}},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Minimum 1, Maximum 200, Default 20","schema":{"type":"integer","default":20,"description":"Number of results to return. Minimum 1, Maximum 200, Default 20"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-add":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_add","summary":"Create webhook subscription","description":"POST /webhook/webhooks","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["x-apideck-app-id","body"],"properties":{"x-apideck-app-id":{"type":"string","description":"The ID of your Unify application"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-one":{"get":{"operationId":"dev_tools_apideck_webhook_webhooks_one","summary":"Get webhook subscription","description":"GET /webhook/webhooks/{id}","tags":["dev-tools"],"parameters":[{"name":"id","in":"query","required":true,"description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source.","schema":{"type":"string","description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source."}},{"name":"x-apideck-app-id","in":"query","required":true,"description":"The ID of your Unify application","schema":{"type":"string","description":"The ID of your Unify application"},"example":"dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-update":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_update","summary":"Update webhook subscription","description":"PATCH /webhook/webhooks/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","x-apideck-app-id","body"],"properties":{"id":{"type":"string","description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source."},"x-apideck-app-id":{"type":"string","description":"The ID of your Unify application"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-delete":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_delete","summary":"Delete webhook subscription","description":"DELETE /webhook/webhooks/{id}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","x-apideck-app-id"],"properties":{"id":{"type":"string","description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source."},"x-apideck-app-id":{"type":"string","description":"The ID of your Unify application"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-execute":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_execute","summary":"Execute a webhook","description":"POST /webhook/webhooks/{id}/execute/{serviceId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","serviceId","body"],"properties":{"id":{"type":"string","description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source."},"serviceId":{"type":"string","description":"Service provider ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/dev-tools:apideck-webhook/webhooks-short-execute":{"post":{"operationId":"dev_tools_apideck_webhook_webhooks_short_execute","summary":"Execute a webhook","description":"POST /webhook/webhooks/{id}/x/{serviceId}","tags":["dev-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","serviceId","body"],"properties":{"id":{"type":"string","description":"JWT Webhook token that represents the unifiedApi and applicationId associated to the event source."},"serviceId":{"type":"string","description":"Service provider ID."},"l_id":{"type":"string","description":"Unique identifier to used to look up consumer/connection when receiving connector events from downstream."},"e":{"type":"string","description":"The name of downstream event when connector does not supply in body or header"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}