Skip to main content

Webhook

The Webhook entity allows you to configure endpoints to be notified about events that happen in your Karla organization.

See Webhooks for more information.

Operations​

Search Webhooks

Search all webhooks or based on some values to filter.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

query Parameters
page
integer (Page) > 0
Default: 1
per_page
integer (Per Page) ( 0 .. 100 ]
Default: 30
uuid
string <uuid> (Uuid)
status
any (WebhookStatus)
Enum: "active" "inactive"

Webhook Status Type.

url
string <uri> (Url) [ 1 .. 65536 ] characters

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Webhook

Create a webhook if it does not exist.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

Request Body schema: application/json
required
enabled_events
Array of strings (Enabled Events)
Default: ["*"]

The list of events to enable for this endpoint. ['*'] (the default) indicates that all events are enabled.See webhooks for more details on how to subscribe to our different events.

secret
string (Secret) [ 16 .. 64 ] characters

The secret used to generate webhook signatures. If undefined, we will generate one for you.See webhooks for more details on how to validate the webhook request.

description
string (Description)

An optional description for the endpoint

status
any (WebhookStatus)
Default: "active"
Enum: "active" "inactive"

The status of the webhook.

url
required
string <uri> (Url) [ 1 .. 65536 ] characters

The URL of the webhook endpoint

Responses

Request samples

Content type
application/json
{
  • "enabled_events": [
    ],
  • "secret": "41013bd9-9072-42cd-9902-66da38361be9",
  • "description": "string",
  • "status": "active",
  • "url": "https://example.com/my-webhook-endpoint"
}

Response samples

Content type
application/json
{
  • "enabled_events": [
    ],
  • "secret": "41013bd9-9072-42cd-9902-66da38361be9",
  • "description": "string",
  • "status": "active",
  • "url": "https://example.com/my-webhook-endpoint",
  • "created_at": "2021-01-01T00:00:00Z",
  • "updated_at": "2021-01-01T00:00:00Z",
  • "uuid": "7022541c-62cd-4de3-9fb2-bfdc74bf7834",
  • "shop_slug": "string"
}

Delete Webhook

Delete a webhook that already exists.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The webhook's unique identifier

Responses

Response samples

Content type
application/json
null

Update Webhook

Update a webhook partially or completely.

Authorizations:
HTTPBasic
path Parameters
slug
required
string (Slug)

The slug identifying the shop

uuid
required
string <uuid> (Uuid)

The webhook's unique identifier

Request Body schema: application/json
required
description
string (Description)

An optional description for the endpoint

status
any (WebhookStatus)
Enum: "active" "inactive"

The status of the webhook.

url
string <uri> (Url) [ 1 .. 65536 ] characters

The URL of the webhook endpoint

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
null

API Reference​