PApartoo
Webhooks

Update a webhook configuration

Changed on

This endpoint updates a webhook configuration.

patch/webhooks/{webhook_id}

Request

Path parameters

webhook_idinteger required

The webhook object identifier.

Query parameters

org_idinteger

Organization identifier, only required for PROVIDER users.

Request body

urlstring required

The URL receiving the webhook's data. Only HTTPS URLs are supported.

custom_headersCustomHeaders

Custom HTTP headers to include in webhook requests. Keys must start with X- (case-insensitive) and must not use the reserved X-Partoo prefix. Maximum 5 headers. Key max length: 128 characters. Value max length: 512 characters. The following characters are forbidden in header keys: space, (, ), <, >, @, ,, ;, :, \, ", /, [, ], ?, =, {, }.

Example request

{
  "url": "https://example.com/webhook",
  "custom_headers": {
    "X-My-Header": "my-value",
    "X-Auth-Token": "secret-token"
  }
}

Response

OK

idinteger required

The identifier for the webhook configuration.

urlstring required

The URL receiving the webhook's data.

event_type'business_created' | 'business_updated' | 'business_deleted' | 'message_updated' | 'message_created' | 'lead_received' | 'review_created' | 'review_updated' | 'review_reply_created' | 'review_reply_updated' | 'review_reply_deleted' | 'email_opt_out_created' | 'post_created' | 'post_updated' | 'post_validated' | 'post_deleted' | 'scheduled_post_pushed' required

The webhook event type.

created_atstring required

An ISO 8601 date-time string representing the webhook creation date.

updated_atstring required

An ISO 8601 date-time string representing the webhook last update date.

org_idinteger required

The organization identifier for the webhook configuration.

custom_headersCustomHeaders

Custom HTTP headers to include in webhook requests. Keys must start with X- (case-insensitive) and must not use the reserved X-Partoo prefix. Maximum 5 headers. Key max length: 128 characters. Value max length: 512 characters. The following characters are forbidden in header keys: space, (, ), <, >, @, ,, ;, :, \, ", /, [, ], ?, =, {, }.

Example response

{
  "id": 1,
  "url": "https://example.com/webhook",
  "event_type": "business_created",
  "created_at": "2024-11-27T16:10:44.929678Z",
  "updated_at": "2024-11-27T16:10:44.929678Z",
  "org_id": 1,
  "custom_headers": {
    "X-My-Header": "my-value",
    "X-Auth-Token": "secret-token"
  }
}

Changes

  • dcb8190f5a29Revision changes
    • warning

      added the new email_opt_out_created enum value to the response property for the response status

    • warning

      added the new post_created enum value to the response property for the response status

    • warning

      added the new post_deleted enum value to the response property for the response status

    • warning

      added the new post_updated enum value to the response property for the response status

    • warning

      added the new post_validated enum value to the response property for the response status

    • warning

      added the new review_created enum value to the response property for the response status

    • warning

      added the new review_reply_created enum value to the response property for the response status

    • warning

      added the new review_reply_deleted enum value to the response property for the response status

    • warning

      added the new review_reply_updated enum value to the response property for the response status

    • warning

      added the new review_updated enum value to the response property for the response status

    • warning

      added the new scheduled_post_pushed enum value to the response property for the response status