Update a webhook endpoint

PUT /api/v1/webhook_endpoints/{webhook_endpoint}

Updates the specified webhook endpoint by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Servers

• Production server: https://api.1099policy.com (Production server)

Parameters

Path parameters

• webhook_endpoint (string)
  The ID of the desired webhook endpoint (e.g., whe_KPGc5vEZdvoETu39BNwu2Z).

Body: application/json (object)

• description (string)
  A human-readable description of the webhook endpoint.

• events (array[string])
  List of event types to subscribe to. If not provided, subscribes to all events. Use "*" to subscribe to all events. Available event types: policy.active, policy.active.media, policy.cancelled, policy.reactivated, application.created, application.started, application.complete, application.expired, application.renewed, application.ineligible, application.manual_review, application.manual_review_approved, assignment.active, assignment.cancelled, certificate.flagged, certificate.approved, certificate.denied, invoice.charge_card_failed, invoice.charge_card_succeeded, category_code.added

• url (string)
  The URL of the webhook endpoint.

Responses

200

Returns a webhook endpoint object if a valid webhook endpoint ID was provided. Returns an error otherwise.

Body: application/json (object)

• created (integer(int64))

• description (string)
  Optional human-readable description of the endpoint.

• id (string)

• secret (string)
  Webhook secret which you can use to verify that the webhook is from 1099Policy. Read more about how to use the webhook secret to verify the webhook signature in our documentation here.

• url (string)
  The URL of the webhook endpoint.