/

Closelink Webhooks API (2.21)

Closelink webhook reference

Servers

Mock server

https://docs.closelink.com/_mock/webhooks/webhooks/

Production Environment

https://public-api.closelink.com/

Staging Environment

https://public-api-staging.closelink.com/

Webhook Management

Operations

Draft Events

Webhooks

Draft CreatedWebhook

Request

Triggered when a draft enquiry is created

Headers

Closelink-Deliveryany

Unique id of the exact webhook execution

Example: 507f1f77bcf86cd799439011

Closelink-Eventany

The resource type of the event

Example: OFFER

Closelink-Signatureany

HMAC signature of the payload using the webhook secret

Example: x48656C6C6F

Bodyapplication/json

dataobject(EnquiryMessage)required

The main data payload of the webhook

actionstringrequired

The type of action that triggered this webhook

Enum"CREATED""UPDATED""DELETED"

Example: "CREATED"

changesArray of objects(ValueChangeObjectObject)required

triggerobject(Trigger)

Information about what triggered this webhook

resourceTypestringrequired

The type of resource the event belongs to

Enum"DRAFT_ENQUIRY""ENQUIRY""OFFER""APPROVAL_REQUEST"

Example: "OFFER"

createdAtstring(date-time)required

When the event was thrown

Example: "2023-01-01T12:00:00Z"

webhookTimestampstring(date-time)required

When the webhook was sent

Example: "2023-01-01T12:00:01Z"

webhookIdstringrequired

Unique identifier for this webhook

Example: "507f1f77bcf86cd799439011"

application/json

{
  "data": { … },
  "action": "CREATED",
  "changes": [ … ],
  "trigger": { … },
  "resourceType": "OFFER",
  "createdAt": "2023-01-01T12:00:00Z",
  "webhookTimestamp": "2023-01-01T12:00:01Z",
  "webhookId": "507f1f77bcf86cd799439011"
}

Responses

Success - No Content

Draft DeletedWebhook

Request

Triggered when a draft enquiry is deleted

Headers

Closelink-Deliveryany

Unique id of the exact webhook execution

Example: 507f1f77bcf86cd799439011

Closelink-Eventany

The resource type of the event

Example: OFFER

Closelink-Signatureany

HMAC signature of the payload using the webhook secret

Example: x48656C6C6F

Bodyapplication/json

dataobject(EnquiryMessage)required

The main data payload of the webhook

actionstringrequired

The type of action that triggered this webhook

Enum"CREATED""UPDATED""DELETED"

Example: "CREATED"

changesArray of objects(ValueChangeObjectObject)required

triggerobject(Trigger)

Information about what triggered this webhook

resourceTypestringrequired

The type of resource the event belongs to

Enum"DRAFT_ENQUIRY""ENQUIRY""OFFER""APPROVAL_REQUEST"

Example: "OFFER"

createdAtstring(date-time)required

When the event was thrown

Example: "2023-01-01T12:00:00Z"

webhookTimestampstring(date-time)required

When the webhook was sent

Example: "2023-01-01T12:00:01Z"

webhookIdstringrequired

Unique identifier for this webhook

Example: "507f1f77bcf86cd799439011"

application/json

{
  "data": { … },
  "action": "CREATED",
  "changes": [ … ],
  "trigger": { … },
  "resourceType": "OFFER",
  "createdAt": "2023-01-01T12:00:00Z",
  "webhookTimestamp": "2023-01-01T12:00:01Z",
  "webhookId": "507f1f77bcf86cd799439011"
}

Responses

Success - No Content

Draft UpdatedWebhook

Request

Triggered when a draft enquiry is updated

Headers

Closelink-Deliveryany

Unique id of the exact webhook execution

Example: 507f1f77bcf86cd799439011

Closelink-Eventany

The resource type of the event

Example: OFFER

Closelink-Signatureany

HMAC signature of the payload using the webhook secret

Example: x48656C6C6F

Bodyapplication/json

dataobject(EnquiryMessage)required

The main data payload of the webhook

actionstringrequired

The type of action that triggered this webhook

Enum"CREATED""UPDATED""DELETED"

Example: "CREATED"

changesArray of objects(ValueChangeObjectObject)required

triggerobject(Trigger)

Information about what triggered this webhook

resourceTypestringrequired

The type of resource the event belongs to

Enum"DRAFT_ENQUIRY""ENQUIRY""OFFER""APPROVAL_REQUEST"

Example: "OFFER"

createdAtstring(date-time)required

When the event was thrown

Example: "2023-01-01T12:00:00Z"

webhookTimestampstring(date-time)required

When the webhook was sent

Example: "2023-01-01T12:00:01Z"

webhookIdstringrequired

Unique identifier for this webhook

Example: "507f1f77bcf86cd799439011"

application/json

{
  "data": { … },
  "action": "CREATED",
  "changes": [ … ],
  "trigger": { … },
  "resourceType": "OFFER",
  "createdAt": "2023-01-01T12:00:00Z",
  "webhookTimestamp": "2023-01-01T12:00:01Z",
  "webhookId": "507f1f77bcf86cd799439011"
}

Responses

Success - No Content

Enquiry Events

Webhooks

Offer Events

Webhooks

Approval Request Events

Webhooks