Customer.io
v1.0.0
OpenAPI 3.1.0

Update a webhook configuration

US region

Client Libraries
Shell Curl

Update a webhook configuration

​

Update the configuration of a reporting webhook. Turn events on or off, change the webhook URL, etc.

Path Parameters
  • webhook_id
    Type: integer
    required

    The identifier of a webhook.

Body
application/json
  • endpoint
    Type: string Format: url
    required

    The webhook URL.

  • events
    Type: array string[] 1…enum
    required

    Specifies the types of events you want to report to your webhook. See our reporting webhooks reference for more information about event types and the information they return.

    values
    • customer_subscribed
    • customer_unsubscribed
    • customer_subscription_preferences_changed
    • email_drafted
    • email_attempted
  • name
    Type: string
    required

    The name of your webhook.

  • disabled
    Type: boolean

    Set to true to quit sending events to the webhook URL. Set to false to enable the webhook.

  • full_resolution
    Type: boolean

    Set to false to send unique open and click events to the webhook. Set to true to send all events.

  • with_content
    Type: boolean

    Set to true to include message content in sent events and topic preferences in cio_subscription_preferences_changed events. This is the Body content option in the UI.

Responses
  • application/json
  • 400

    The request was malformed.

  • 404

    The webhook ID does not exist.

  • application/json
Request Example for put/v1/reporting_webhooks/{webhook_id}
{
  "endpoint": "https://example.com/webhook",
  "events": [
    "email_failed",
    "webhook_failed"
  ],
  "name": "my cool webhook",
  "disabled": false,
  "full_resolution": true,
  "with_content": false
}

{
  "endpoint": "https://example.com/webhook",
  "events": [
    "email_failed",
    "webhook_failed"
  ],
  "name": "my cool webhook",
  "disabled": false,
  "full_resolution": true,
  "id": 4,
  "type": "webhook",
  "with_content": false
}

Returns your webhook configuration and the ID of the webhook.