Back to endpoints

Get webhooks for an organization

GET api/V3/{language}/org/{orgIdentifier}/webhooks

?page={page}

&perPage={perPage}

Returns a list of all webhooks for the organization, including their status.

Request Information

URI Parameters

PARAMETERS
language (string)

Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en'

 Required
orgIdentifier (string)

Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'.

Required
page (integer)

Result page number that appears first.

Default value is 1

 Optional
perPage (integer)

Number of results per page.

Default value is 200

 Optional

Body Parameters

None.

Response Information

Resource Description

PARAMETERS
Context (OrgContext)
OrganizationId (integer)

Id of the organization. This one cannot be substituted for rewriteUrl, contrary to the organization id in the query parameters
Id (integer)

Resource id
Name (string)

Resource name
Url (string)

Url of the resource
Action (Action)
Version (Version)
Status (DeliveryStatus)

Object containing the possible status values (case-insensitive).

Response Formats

CODE SAMPLE JSON 
[
  {
    "Context": "Registration",
    "OrganizationId": 1101,
    "Id": 1,
    "Name": "Sample Webhook",
    "Url": "https://webhook.example.com/registrations",
    "Action": "Create",
    "Version": "V1",
    "Status": "Active"
  },
  {
    "Context": "Registration",
    "OrganizationId": 1101,
    "Id": 1,
    "Name": "Sample Webhook",
    "Url": "https://webhook.example.com/registrations",
    "Action": "Create",
    "Version": "V1",
    "Status": "Active"
  }
]