Search
K
[dev] 🇫🇷 Classifieds Management V4

Subscribe to the webhook and get a notification when a classified has a new status.

Receive in real-time all the events related to the processing of your classifieds. You will receive the statuses of your classifieds in PUSH mode to prevent from wasteful polling requests.

put

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

Body

application/json

Webhook

urlstring(url)required

The HTTP address our server will call to send the events as it occurs.

statusesarray[string]

The list of statuses that will trigger the sending of the notification.

Allowed values:RECEIVEDRECEIVINGRECEIVING_FAILEDCREATINGCREATEDCREATING_FAILEDUPDATINGUPDATEDUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

Response

application/json

successful operation

string

Callbacks

post
{$request.body#/url}/classifieds/classifiedId/statuses

Callback Path Parameters

classifiedIdstringrequired

ID of the classified to create a new status for

Callback Response

201

Your server returns this code if it accepts the callback

put/webhooks

Body

{ "url": "https://my.notification-url.com", "statuses": [ "RECEIVED" ] }
 
application/json
callback sample
Callback Body
Callback Response
201

Unsubscribe to a webhook and stop to get notifications when a classified has a new status.

Unsubscribe to a webhook and stop to get notifications when a classified has a new status.

delete

Headers

traceparentstring

Identifies the incoming request in the tracing system

Example:00-0af7651916cd43dd8448eb211c80319c-b9c7c989f97918e1-01

User-Agentstringrequired

Characteristic string that identifies the application, operating system, vendor, and version of the requesting user agent.

Syntax : User-Agent: <crm-software-name>/<crm-software-version> <tool-name>/<tool-version> <operating-system>/<operating-system-version>

All subset parts of this string do not allow the following characters : / and (whitespace)

Match pattern:^[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+\s{1}[^\/\s]+\/[^\/\s]+$

Example:MyAwesomeSoft/1.0.0 curl/7.52.1 debian/9~1.gbpf8534c

Response

application/json

successful operation

string
delete/webhooks
 
application/json

Webhook

object
urlstring(url)required

The HTTP address our server will call to send the events as it occurs.

statusesarray[string]

The list of statuses that will trigger the sending of the notification.

Allowed values:RECEIVEDRECEIVINGRECEIVING_FAILEDCREATINGCREATEDCREATING_FAILEDUPDATINGUPDATEDUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

Example

ClassifiedStatus

object
portalsarray[string]required

Portal where to publish the classified

Allowed values:SLBUCOMBDSLCSLN

statusstringrequired

classified status

Allowed values:RECEIVINGRECEIVEDRECEIVING_FAILEDCREATINGCREATEDCREATED_WITH_MEDIA_ERRORCREATING_FAILEDUPDATINGUPDATEDUPDATED_WITH_MEDIA_ERRORUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

Example:RECEIVED

messagestringrequired

Example:The classified has successfully been received in our system

subStatusstring

classified status

Allowed values:RECEIVING_POSTRECEIVED_POSTRECEIVING_FAILED_POSTRECEIVING_PUTRECEIVED_PUTRECEIVING_FAILED_PUTRECEIVING_DELETERECEIVED_DELETERECEIVING_FAILED_DELETE

Example:RECEIVED_POST

subStatusDetailsstring
statusDatestring(date-time)required
mediaStatusesarray[object]

List of media statuses associated with the classified

Show Child Parameters
Example

ClassifiedStatusInternal

statusIdstringrequired

Example:e91d4fb9-80d5-45bf-9839-ff02b597b12d

classifiedIdstringrequired

Example:196354e0-5258-4c5c-8c1e-bb588ddc0a41

customerIdstringrequired

Example:207564e0-5369-5d6d-9d2f-cc699eed1b52

creationDatestring(date-time)required
revisionintegerrequired

Identifier for a specific version of a classified resource

>= 1

Example:2

portalsarray[string]required

Portal where to publish the classified

Allowed values:SLBUCOMBDSLCSLN

statusstringrequired

classified status

Allowed values:RECEIVINGRECEIVEDRECEIVING_FAILEDCREATINGCREATEDCREATED_WITH_MEDIA_ERRORCREATING_FAILEDUPDATINGUPDATEDUPDATED_WITH_MEDIA_ERRORUPDATING_FAILEDDELETINGDELETEDDELETING_FAILED

Example:RECEIVED

messagestringrequired

Example:The classified has successfully been received in our system

subStatusstring

classified status

Allowed values:RECEIVING_POSTRECEIVED_POSTRECEIVING_FAILED_POSTRECEIVING_PUTRECEIVED_PUTRECEIVING_FAILED_PUTRECEIVING_DELETERECEIVED_DELETERECEIVING_FAILED_DELETE

Example:RECEIVED_POST

subStatusDetailsstring
statusDatestring(date-time)required
mediaStatusesarray[object]

List of media statuses associated with the classified

Show Child Parameters
Example