---
updatedAt: 2026-04-21T00:22:01.000Z
---

Fetch the complete documentation index at: https://developer.servicem8.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Create or Update an Object Webhook Subscription

Subscribe to changes on specific fields of an object type (e.g., job, company). When any of the specified fields change, a webhook will be sent to your callback URL.

Your callback URL must return a successful `2xx` response within 10 seconds. Requests that take longer than 10 seconds are treated as timeouts. Repeated failed deliveries, including repeated timeouts, can cause the subscription to be automatically deactivated.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Webhooks API",
    "description": "API for managing webhook subscriptions. This specification includes 25 dynamically registered webhook events.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.servicem8.com"
    }
  ],
  "paths": {
    "/webhook_subscriptions/object": {
      "post": {
        "operationId": "post_object_webhook_subscription",
        "tags": [
          "Webhook Subscription"
        ],
        "summary": "Create or Update an Object Webhook Subscription",
        "description": "Subscribe to changes on specific fields of an object type (e.g., job, company). When any of the specified fields change, a webhook will be sent to your callback URL.\n\nYour callback URL must return a successful `2xx` response within 10 seconds. Requests that take longer than 10 seconds are treated as timeouts. Repeated failed deliveries, including repeated timeouts, can cause the subscription to be automatically deactivated.",
        "requestBody": {
          "required": true,
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "$ref": "#/components/schemas/CreateObjectWebhookRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                },
                "examples": {
                  "success": {
                    "value": {
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Result"
                },
                "examples": {
                  "error": {
                    "value": {
                      "success": false,
                      "message": "Object Potato does not support subscription"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CreateObjectWebhookRequest": {
        "type": "object",
        "required": [
          "object",
          "fields",
          "callback_url"
        ],
        "properties": {
          "object": {
            "type": "string",
            "description": "Object type to subscribe to (e.g. job, company).",
            "maxLength": 64
          },
          "fields": {
            "type": "string",
            "description": "Comma-separated list of fields in the object to subscribe to."
          },
          "callback_url": {
            "type": "string",
            "format": "uri",
            "description": "The URL on your server that will receive webhooks when a subscribed field changes. This endpoint must return a successful `2xx` response within 10 seconds."
          },
          "unique_id": {
            "type": "string",
            "description": "Optional unique identifier for grouping subscriptions.",
            "maxLength": 100
          }
        },
        "description": "Create or update an object-based webhook subscription. Your callback URL must return a successful `2xx` response within 10 seconds, otherwise the delivery is treated as a timeout. Repeated failed deliveries, including repeated timeouts, can cause the subscription to be automatically deactivated."
      },
      "Result": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "description": "Indicates whether the operation succeeded"
          },
          "message": {
            "type": "string",
            "description": "If the operation did not succeed, this property will contain a description of the error."
          },
          "detail": {
            "type": "string",
            "description": "Additional error detail when available."
          },
          "errorCode": {
            "type": "integer",
            "description": "Optional error code for non-success responses."
          }
        }
      }
    }
  }
}
```