--- title: "WebhookEvents.get" method: GET path: "/entities/WebhookEvents/{id}" tags: ["Webhook"] --- # WebhookEvents.get `GET /entities/WebhookEvents/{id}` ## Request - Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id` - URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/WebhookEvents/{id}` - Auth: HTTP basic - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the WebhookEvent record with the given id. ## Path parameters - `id` string, uuid, required ## Query parameters - `expand` string ## Response `200` The WebhookEvent record. - object - `success` boolean: True when the request succeeded; false on error. - `data` WebhookEvent: Event a webhook subscribes to; the webhook is called whenever the event occurs. - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only. - `id` string, uuid, required: Unique identifier of entity. - `is_deleted` boolean: Specifies if the entity is considered deleted. - `modified` string, date-time: Last modification time. - `created` string, date-time: Creation time. - `webhook` string, uri, required: Webhook this subscription belongs to. The parent webhook is fired whenever the subscribed event occurs. Related Webhook record, returned as the URI of the record. With the 'expand' parameter the full record is returned instead; see 'Webhook' for its fields. - `event` '*' | 'Account.*' | 'Account.Create' | 'Account.Delete' | 'Account.DocumentLinked' | 'Account.OwnerChanged' | 'Account.Update' | 'ActivityRelation.*' | 'ActivityRelation.Create' | 'ActivityRelation.Delete' | 'ActivityRelation.Update' | 'Appointment.*' | 'Appointment.Comment' | 'Appointment.Create' | 'Appointment.Delete' | 'Appointment.DocumentLinked' | 'Appointment.OwnerChanged' | 'Appointment.Update' | 'Contact.*' | 'Contact.Create' | 'Contact.Delete' | 'Contact.DocumentLinked' | 'Contact.OwnerChanged' | 'Contact.Update' | 'ContactAccountRelation.*' | 'ContactAccountRelation.Create' | 'ContactAccountRelation.Delete' | 'ContactAccountRelation.Update' | 'Currency.*' | 'Currency.Create' | 'Currency.Delete' | 'Currency.Update' | 'CurrencyExchangeRate.*' | 'CurrencyExchangeRate.Create' | 'CurrencyExchangeRate.Delete' | 'CurrencyExchangeRate.Update' | 'CurrencyExchangeRatesList.*' | 'CurrencyExchangeRatesList.Create' | 'CurrencyExchangeRatesList.Delete' | 'CurrencyExchangeRatesList.Update' | 'CustomEntity.*' | 'CustomEntity.Create' | 'CustomEntity.Delete' | 'CustomEntity.DocumentLinked' | 'CustomEntity.OwnerChanged' | 'CustomEntity.Update' | 'Email.*' | 'Email.Create' | 'Email.Delete' | 'Email.DocumentLinked' | 'Email.Update' | 'Lead.*' | 'Lead.BackToLead' | 'Lead.Create' | 'Lead.Delete' | 'Lead.DocumentLinked' | 'Lead.Lost' | 'Lead.OwnerChanged' | 'Lead.Update' | 'LeadOpptyAccountRelation.*' | 'LeadOpptyAccountRelation.Create' | 'LeadOpptyAccountRelation.Delete' | 'LeadOpptyAccountRelation.Update' | 'LeadOpptyContactRelation.*' | 'LeadOpptyContactRelation.Create' | 'LeadOpptyContactRelation.Delete' | 'LeadOpptyContactRelation.Update' | 'Memo.*' | 'Memo.Comment' | 'Memo.Create' | 'Memo.Delete' | 'Memo.DocumentLinked' | 'Memo.Update' | 'Message.*' | 'Message.Create' | 'Message.Delete' | 'Message.DocumentLinked' | 'Message.Update' | 'Note.*' | 'Note.Create' | 'Note.Delete' | 'Note.Update' | 'Opportunity.*' | 'Opportunity.Create' | 'Opportunity.Delete' | 'Opportunity.DocumentLinked' | 'Opportunity.Lost' | 'Opportunity.Move' | 'Opportunity.OwnerChanged' | 'Opportunity.Qualify' | 'Opportunity.Update' | 'Opportunity.Won' | 'OpptyProductRelation.*' | 'OpptyProductRelation.Create' | 'OpptyProductRelation.Delete' | 'OpptyProductRelation.Update' | 'Product.*' | 'Product.Create' | 'Product.Delete' | 'Product.Update' | 'ProductPriceList.*' | 'ProductPriceList.Create' | 'ProductPriceList.Delete' | 'ProductPriceList.Update' | 'ProductPriceListPrice.*' | 'ProductPriceListPrice.Create' | 'ProductPriceListPrice.Delete' | 'ProductPriceListPrice.Update' | 'Project.*' | 'Project.Create' | 'Project.Delete' | 'Project.DocumentLinked' | 'Project.OwnerChanged' | 'Project.Update' | 'Quote.*' | 'Quote.Create' | 'Quote.Delete' | 'Quote.DocumentLinked' | 'Quote.Lost' | 'Quote.Move' | 'Quote.OwnerChanged' | 'Quote.Update' | 'Quote.Won' | 'QuoteAccountRelation.*' | 'QuoteAccountRelation.Create' | 'QuoteAccountRelation.Delete' | 'QuoteAccountRelation.Update' | 'QuoteContactRelation.*' | 'QuoteContactRelation.Create' | 'QuoteContactRelation.Delete' | 'QuoteContactRelation.Update' | 'Task.*' | 'Task.Comment' | 'Task.Create' | 'Task.Delete' | 'Task.DocumentLinked' | 'Task.OwnerChanged' | 'Task.Update', required: Event type the parent webhook subscribes to (e.g. Account.Create, Lead.Update). The webhook fires whenever an event of this type occurs in the team space. - `webhook_id` string, uuid, required: Id of the parent webhook. ## Other responses - `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. - `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). - `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). - `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry. - `500`: Unexpected server error (code 1000, ERROR_UNKNOWN). --- [API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)