Update a webhook endpoint

PUT /api/v1/webhook_endpoints/{webhook_endpoint_id}

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

application/json

Body

  • created string
  • 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.

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 string
    • 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.
PUT /api/v1/webhook_endpoints/{webhook_endpoint_id} 
curl \
 -X PUT https://api.1099policy.com/api/v1/webhook_endpoints/{webhook_endpoint_id} \
 -H "Content-Type: application/json" \
 -d '{"description":"Webhook for contractor insurance application events.","url":"https://example.com/my/webhook/endpoint"}'
Request example 
{
  "description": "Webhook for contractor insurance application events.",
  "url": "https://example.com/my/webhook/endpoint"
}
Response examples (200) 
{
  "created": "2024-01-06T05:30:39.373Z",
  "description": "string",
  "id": "whe_KPGc5vEZdvoETu39BNwu2Z",
  "secret": false,
  "url": "https://example.com/my/webhook/endpoint"
}