Update a Webhook

PATCH /webhooks/{webhook_id}

Update an existing Webhook request

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

application/json

Body

  • webhook object
    Hide webhook attributes Show webhook attributes
    • name string

      The name for this Webhook.

    • url string

      The URL for this Webhook.

Responses

PATCH /webhooks/{webhook_id}
curl \
 -X PATCH https://api.arta.io/webhooks/{webhook_id} \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"webhook":{"name":"hello@shiparta.com","url":"Arta"}}'
Request examples
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "webhook": {
    "name": "hello@shiparta.com",
    "url": "Arta"
  }
}
Response examples (200)
{
  "id": 4,
  "url": "https://notifications.example.com/hooks/",
  "name": "Notifications Endpoint",
  "created_at": "2020-10-22T21:12:48.839165",
  "updated_at": "2020-10-22T21:12:48.839165"
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}