openapi: 3.2.0 info: title: Apideck Webhook Events API version: 10.24.12 contact: email: hello@apideck.com url: https://developers.apideck.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html x-apideck-api: file-storage x-apideck-sdk-support: true x-logo: url: https://developers.apideck.com/icon.png description: 'Operations tagged Webhook Events across 2 of this provider''s published API definitions: apideck-file-storage-openapi.yml, apideck-webhook-events-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://unify.apideck.com security: - apiKey: [] tags: - name: Webhook Events paths: {} webhooks: FileCreated: post: summary: File Created description: Event broadcast when a file has been created. operationId: fileCreated x-apideck-event-type: file-storage.file.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/FileStorageEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/FileStorageWebhookEvent' example: payload: event_type: file-storage.file.created unified_api: file-storage service_id: dropbox consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/file-storage/files/123456ASDF entity_type: file occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] servers: - url: https://unify.apideck.com FileUpdated: post: summary: File Updated description: Event broadcast when a file has been updated. operationId: fileUpdated x-apideck-event-type: file-storage.file.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/FileStorageEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/FileStorageWebhookEvent' example: payload: event_type: file-storage.file.updated unified_api: file-storage service_id: dropbox consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/file-storage/files/123456ASDF entity_type: file occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] servers: - url: https://unify.apideck.com FileDeleted: post: summary: File Deleted description: Event broadcast when a file has been deleted. operationId: fileDeleted x-apideck-event-type: file-storage.file.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/FileStorageEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/FileStorageWebhookEvent' example: payload: event_type: file-storage.file.deleted unified_api: file-storage service_id: dropbox consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/file-storage/files/123456ASDF entity_type: file occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] servers: - url: https://unify.apideck.com DriveUpdated: post: summary: Drive Updated description: Event broadcast when a drive has been updated. operationId: driveUpdated x-apideck-event-type: file-storage.drive.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/FileStorageEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/FileStorageWebhookEvent' example: payload: event_type: file-storage.drive.updated unified_api: file-storage service_id: dropbox consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/file-storage/drives/123456ASDF entity_type: drive occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] servers: - url: https://unify.apideck.com components: schemas: FileStorageWebhookEvent: allOf: - type: object x-apideck-schema-id: WebhookEvent properties: event_id: type: string description: Unique reference to this request event example: 9755c355-56c3-4a2f-a2da-86ff4411fccb unified_api: description: Name of Apideck Unified API x-apideck-enum-id: unified_api enum: - 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 example: crm type: string service_id: type: string description: Service provider identifier example: close consumer_id: type: string example: test_consumer_id description: Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID. entity_id: type: string description: The service provider's ID of the entity that triggered this event example: 123456ASDF entity_type: type: string description: The type entity that triggered this event example: Company entity_url: type: string description: The url to retrieve entity detail. example: https://unify.apideck.com/crm/contacts/123456 execution_attempt: type: number description: The current count this request event has been attempted example: 2 occurred_at: type: string description: ISO Datetime for when the original event occurred example: '2021-10-01T03:14:55.419Z' - properties: event_type: $ref: '#/components/schemas/FileStorageEventType' type: object x-sdk-exclude: true FileStorageEventType: x-apideck-enum-id: file-storage.event_type type: string enum: - '*' - file-storage.file.created - file-storage.file.updated - file-storage.file.deleted - file-storage.drive.updated example: file-storage.file.created securitySchemes: apiKey: type: apiKey in: header name: Authorization description: 'To access our API, you need to sign up and obtain your unique API key. Each Unify application is assigned a single API key. You can locate your API key in the Configuration Settings section of your Apideck application. Additionally, your application’s application_id is available on the same page. Authenticate your API requests by including your test or live secret API key in the request header. - Bearer authorization header: `Authorization: Bearer "YOUR_API_KEY_HERE"` - Application id header: `x-apideck-app-id: "YOUR_APP_ID_HERE"` You should use the public keys on the SDKs and the secret keys to authenticate API requests. **Do not share or include your secret API keys on client side code.** Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub. Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys ' externalDocs: description: Apideck Developer Docs url: https://developers.apideck.com x-refined-from: - apideck-file-storage-openapi.yml - apideck-webhook-events-api-openapi.yml x-webhooks: x-sdk-exclude: true x-speakeasy-ignore: true CustomerCreated: post: summary: Customer Created operationId: customerCreated x-apideck-event-type: accounting.customer.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been created. CustomerUpdated: post: summary: Customer Updated operationId: customerUpdated x-apideck-event-type: accounting.customer.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been updated. CustomerDeleted: post: summary: Customer Deleted operationId: customerDeleted x-apideck-event-type: accounting.customer.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.customer.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/customers/123456ASDF entity_type: customer occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a customer has been deleted. InvoiceCreated: post: summary: Invoice Created operationId: invoiceCreated x-apideck-event-type: accounting.invoice.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been created. InvoiceUpdated: post: summary: Invoice Updated operationId: invoiceUpdated x-apideck-event-type: accounting.invoice.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been updated. InvoiceDeleted: post: summary: Invoice Deleted operationId: invoiceDeleted x-apideck-event-type: accounting.invoice.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoices/123456ASDF entity_type: invoice occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been deleted. InvoiceItemCreated: post: summary: Invoice Item Created operationId: invoiceItemCreated x-apideck-event-type: accounting.invoice_item.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item created. InvoiceItemUpdated: post: summary: Invoice Item Updated operationId: invoiceItemUpdated x-apideck-event-type: accounting.invoice_item.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item updated. InvoiceItemDeleted: post: summary: Invoice Item Deleted operationId: invoiceItemDeleted x-apideck-event-type: accounting.invoice_item.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.invoice_item.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/invoice_items/123456ASDF entity_type: invoice_item occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when an invoice has been item deleted. LedgerAccountCreated: post: summary: Ledger Account Created operationId: ledgerAccountCreated x-apideck-event-type: accounting.ledger_account.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account created. LedgerAccountUpdated: post: summary: Ledger Account Updated operationId: ledgerAccountUpdated x-apideck-event-type: accounting.ledger_account.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account updated. LedgerAccountDeleted: post: summary: Ledger Account Deleted operationId: ledgerAccountDeleted x-apideck-event-type: accounting.ledger_account.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.ledger_account.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/ledger_accounts/123456ASDF entity_type: ledger_account occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a ledger has been account deleted. TaxRateCreated: post: summary: Tax Rate Created operationId: taxRateCreated x-apideck-event-type: accounting.tax_rate.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate created. TaxRateUpdated: post: summary: Tax Rate Updated operationId: taxRateUpdated x-apideck-event-type: accounting.tax_rate.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate updated. TaxRateDeleted: post: summary: Tax Rate Deleted operationId: taxRateDeleted x-apideck-event-type: accounting.tax_rate.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.tax_rate.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/tax_rates/123456ASDF entity_type: tax_rate occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a tax has been rate deleted. PurchaseOrderCreated: post: summary: Purchase Order Created operationId: purchaseOrderCreated x-apideck-event-type: accounting.purchase_order.created parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order created. PurchaseOrderDeleted: post: summary: Purchase Order Deleted operationId: purchaseOrderDeleted x-apideck-event-type: accounting.purchase_order.deleted parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order deleted. PurchaseOrderUpdated: post: summary: Purchase Order Updated operationId: purchaseOrderUpdated x-apideck-event-type: accounting.purchase_order.updated parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: $ref: '#/components/schemas/AccountingEventType' - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 tags: - Webhook Events requestBody: content: application/json: schema: type: object properties: payload: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.purchase_order.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/purchase_orders/123456ASDF entity_type: purchase_order occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully. security: [] description: Event broadcast when a purchase has been order updated. ExpenseUpdated: post: summary: Expense Updated description: Event broadcast when an expense has been updated. operationId: expenseUpdated x-apideck-event-type: accounting.expense.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.updated - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] ExpenseDeleted: post: summary: Expense Deleted description: Event broadcast when an expense has been deleted. operationId: expenseDeleted x-apideck-event-type: accounting.expense.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.deleted - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] ExpenseCreated: post: summary: Expense Created description: Event broadcast when an expense has been created. operationId: expenseCreated x-apideck-event-type: accounting.expense.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.expense.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/expenses/123456ASDF entity_type: expense occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: - name: x-apideck-event-type in: header required: true description: The type of event that was triggered schema: type: string example: accounting.expense.created - name: x-apideck-signature in: header required: true description: HMAC SHA-256 signature of the request body, used to verify the webhook came from Apideck schema: type: string example: 2c3b38f1a9b3349afe38829713dcd9722f47dec3ce8906ad93ce803a33f2a8a3 - name: x-apideck-idempotency-key in: header required: true description: A unique identifier for the webhook event, can be used to prevent duplicate processing schema: type: string example: e91dea5d-8ff6-4099-8b33-d3162fb4a042 security: [] QuoteDeleted: post: summary: Quote Deleted description: Event broadcast when a quote has been deleted. operationId: quoteDeleted x-apideck-event-type: accounting.quote.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] QuoteCreated: post: summary: Quote Created description: Event broadcast when a quote has been created. operationId: quoteCreated x-apideck-event-type: accounting.quote.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] QuoteUpdated: post: summary: Quote Updated description: Event broadcast when a quote has been updated. operationId: quoteUpdated x-apideck-event-type: accounting.quote.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/WebhookEvent' example: payload: event_type: accounting.quote.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/quotes/123456ASDF entity_type: quote occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectUpdated: post: summary: Project Updated description: Event broadcast when a project has been updated. operationId: projectUpdated x-apideck-event-type: accounting.project.updated tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.updated unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectCreated: post: summary: Project Created description: Event broadcast when a project has been created. operationId: projectCreated x-apideck-event-type: accounting.project.created tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.created unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: [] ProjectDeleted: post: summary: Project Deleted description: Event broadcast when a project has been deleted. operationId: projectDeleted x-apideck-event-type: accounting.project.deleted tags: - Webhook Events requestBody: content: application/json: schema: $ref: '#/components/schemas/AccountingWebhookEvent' example: payload: event_type: accounting.project.deleted unified_api: accounting service_id: xero consumer_id: test_user_id event_id: d290f1ee-6c54-4b01-90e6-d701748f0851 entity_id: 123456ASDF entity_url: https://unify.apideck.com/accounting/projects/123456ASDF entity_type: project occurred_at: '2020-01-01T00:00:00.000Z' responses: '200': description: Return a 200 status to indicate that the data was received successfully parameters: [] security: []