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

webhook_id integer Required

webhook_id parameter

application/json

Body

webhook object Required
Hide webhook attributes Show webhook attributes object
- name string
  
  The name for this Webhook.
- url string
  
  The URL for this Webhook.

Responses

200 application/json

Successful Webhook response
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- created_at string
- id integer(int64)
- name string
- updated_at string
- url string
404 application/json

Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute object
  
  detail string

PATCH /webhooks/{webhook_id}

curl \
 --request PATCH 'https://api.arta.io/webhooks/{webhook_id}' \
 --header "Content-Type: application/json" \
 --header "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 --data '{"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"
  }
}