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.

Path parameters

  • webhook_endpoint string Required

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

application/json

Body

  • 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.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 application/json

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

    Hide response attributes Show response attributes object
    • created integer(int64)

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • description string

      Optional human-readable description of the endpoint.

    • id string

      Unique identifier for the object.

    • 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.
PUT /api/v1/webhook_endpoints/{webhook_endpoint} 
curl \
 --request PUT 'https://api.1099policy.com/api/v1/webhook_endpoints/whe_KPGc5vEZdvoETu39BNwu2Z' \
 --header "Content-Type: application/json" \
 --data '{"url":"https://example.com/my/webhook/endpoint","events":["application.complete","application.ineligible","policy.active"],"description":"A webhook endpoint for the example application."}'
Request example 
{
  "url": "https://example.com/my/webhook/endpoint",
  "events": [
    "application.complete",
    "application.ineligible",
    "policy.active"
  ],
  "description": "A webhook endpoint for the example application."
}
Response examples (200) 
{
  "created": 1646818364,
  "description": "string",
  "id": "string",
  "secret": false,
  "url": "https://example.com/my/webhook/endpoint"
}