Teamwork CRM API

Getting access, Developing, Testing

Back to Teamwork CRM

Retrieve a webhook request

For more information read our webhooks guide.

The following values are allowed in the include query parameter:

  • event
  • sourceUser
  • webhook

Input

type: object properties: parameters: type: object properties: include: type: string description: |- Comma separated list of relationships to include in the response. See [including related entities](/crm/general/related-entities) for more detailed documentation of how this works. id: type: integer required: - id title: Parameters

Output

type: object title: webhookRequestResponse properties: included: type: object title: Included webhookRequest: type: object title: WebhookRequest properties: createdAt: type: string description: When the item was created, as a datetime format: date-time createdBy: type: object properties: id: type: integer type: type: string enum: - users deletedAt: type: string description: When the item was deleted, as a datetime format: date-time deletedBy: type: object properties: id: type: integer type: type: string enum: - users event: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users". id: type: integer requestBody: type: string description: Request body as a JSON string requestHeaders: type: string description: Request headers as a JSON string responseBody: type: string description: Response body as a JSON string responseHeaders: type: string description: Response headers as a JSON string responseStatus: type: integer description: HTTP status code of the response status: type: string description: Status of the request. enum: - success - error updatedAt: type: string description: When the item was last updated, as a datetime format: date-time updatedBy: type: object properties: id: type: integer type: type: string enum: - users updatedSourceId: type: integer description: Source ID of the latest request made (API / Web app) url: type: string description: The URL the request was made to. uuid: type: string description: Universal unique identifier of the event that triggered the request. webhook: type: object properties: id: type: integer description: The id related entity. type: type: string description: The type of the related entity, e.g "users".