echonovum Docs Help

Opportunity created

This webhook is triggered whenever an opportunity created.

Data Structure

Below you find an example payload for the opportunity_created event.

{ "event": "opportunity_create", "type": "opportunity", "id": "bfee5a3a-32fc-48b2-bcaa-5013b84f6a1b", "status": "TODO", "createdAt": "2024-05-16T09:23:01+00:00", "dueAt": "2024-06-16T09:23:01+00:00", "lastUpdatedAt": "2024-05-16T09:23:01+00:00", "assignees": [ { "id": "eaccdf1e-9755-4519-babd-51485f745cb6", "email": "siri@echonovum.com" }, { "id": "0f17913e-4bc3-42e3-a9db-5c474534adcb", "email": "john@echonovum.com" } ], "relatedResources": [{ "type": "feedback", "uuid": "d239a160-2ada-451a-80a6-ed8dd9de7620", // ... }] }

Available Properties

Event

The event that triggered the webhook. In this case, it is opportunity_create.

Property: event

Type: string

Required: true

Type

The data type the webhook transfers. In this case, it is opportunity.

Property: type

Type: string

Required: true

ID

The unique identifier of the opportunity.

Property: uuid

Type: string

Required: true

Status

The status of the opportunity.

Property: status

Type: string

Required: true

Available values: TODO, IN_PROGRESS, DONE

Creation Date

The date and time the opportunity was created.

Property: createdAt

Type: string

Format: datetime

Required: true

Update Date

The date and time the opportunity was last updated.

Property: lastUpdatedAt

Type: string

Format: datetime

Required: false

Due Date

The date and time the opportunity is due.

Property: dueAt

Type: string

Format: datetime

Required: false

Assignees

The users assigned to the opportunity.

Property: assignees

Type: array

Required: false

Related Resources

The resources related to the opportunity.

Property: relatedResources

Type: array

Required: false

Usually contains a single resource of type feedback.

Last modified: 29 May 2024