Offer Webhooks

These webhooks notify you of events related to offers.

#Worker Offer Response

When a worker receives an offer either from an offer API call you previously made or from the portal, they can either apply or reject it. This response can be passed back to your internal system via this webhook.

#Endpoint

POST https://<yourbaseUrl>/offer/response HTTP/1.1
Copy

#Payload Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "offerId": {
      "type": "string",
      "description" : "Id assigned to this offer."
      "format": "uuid"
    },
    "workerId": {
      "type": "string",
      "description" : "Id assigned to this worker.",
      "format": "uuid"
    },
    "response": {
      "type": "string",
      "description" : "Whether the user accepted or rejected the offer.",
      "enum" : ["accepted", "rejected"]
    }
  }
}
Copy

#Payload Example

{
    "offerId":  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "workerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "response": "accepted" 
}
Copy

#Worker Deleted Offer

After a worker has been assigned within an offer by a hirer or agency, an event is automatically added to their timeline. If they subsequently delete this event from their timeline, this webhook will inform you and you can take the appropriate action - for example contacting the parties involved to understand why this occurred or if the worker did this by mistake.

#Endpoint

POST https://<yourbaseUrl>/offer/eventDeleted HTTP/1.1
Copy

#Payload Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "offerId": {
      "type": "string",
      "description" : "Id assigned to this offer."
      "format": "uuid"
    },
    "workerId": {
      "type": "string",
      "description" : "Id assigned to this worker.",
      "format": "uuid"
    },
    "eventStart": {
      "type": "date-time",
      "description" : "The start date/time (UTC) of the specific event which was removed by the worker.",
    }
  }
}
Copy

#Payload Example

{
    "offerId":  "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "workerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "eventStart": "2018-04-23T09:00:00.511Z" 
}
Copy