Get all Events for Webhook

GET 
/webhook/:guid/event

deprecated

Returns all the WebhookEvents attached to the Webhook.

Request

Path Parameters

guid uuidrequired

The guid of the Webhook.

Responses

200

The attached WebhookEvents of Webhook found.

application/json

Schema

Schema

• Array [

guid uuid

The guid of the WebhookEvent.

webhook_id uuid

The guid of the Webhook the WebhookEvent belongs to. Note, the WebhookEvent will be created due to a single trigger, the Webhook specifies the action to perform.

event string

Possible values: [order-updated, order-pending, order-paid, order-cancelled]

The trigger that will invoke the Webhook.

url url

The url to which to make POST request(s) after a trigger of the event. Only if a request fails, there can be a retry.

data string

Data that is posted along with the event to the url.

tries integer

Default value: 0

How many times have been tried communicating the WebhookEvent to the url.

communicated boolean

Whether we received a HTTP 200 code on the response to any of the requests.

created_at ISO 8601

The time it was created.

updated_at ISO 8601

The time it was last updated.

• ]

Example (from schema)

[
  {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "webhook_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "event": "order-updated",
    "url": "string",
    "data": "string",
    "tries": 0,
    "communicated": true,
    "created_at": "string",
    "updated_at": "string"
  }
]

403

When the authenticated User does not have the admin role.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

When the Webhook to reinstate cannot be found or it has not been deleted.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...