Istores API Documentation
MyIstores Api

webhook

Endpoint:https://api.istores.co.il

Get list of webhooks

POST
https://api.istores.co.il
/automation/webhooks

Get list of webhooks the data related and events

Get list of webhooks › Request Body
optional

  • offsetinteger

    The offset of the results (start from offset and get the limit)

    Example: 0
  • limitinteger · max: 50

    The limit of results for pagination

    Example: 20
  • searchstring

    Search webhooks by name or description

    Example: my webhook 2

Get list of webhooks › Responses

  • webhook_idinteger

    The ID of the webhook used for single webhook actions

    Example: 4
  • namestring

    Webhook name to recognize

    Example: Webhook name
  • descriptionstring

    Webhook description

    Example: Webhook description
  • eventsinteger[]
  • actionstring

    Request action (post/get/put/delete)

    Example: post
  • urlstring

    Valid url for webhook

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body content type (system/custom)

    Example: system

Create single webhook

POST
https://api.istores.co.il
/automation/webhook

Create single webhook

Create single webhook › Request Body
optional

  • namestring

    The name of the webhook

    Example: webhook1
  • descriptionstring

    The description of the webhook

    Example: description1
  • eventsinteger[]

    Array of evnt ids (check webhook event request)

    Example: [1,2]
  • actionstring

    The action of the webhook request (post/put/delete/get)

    Example: post
  • urlstring

    The url of the webhook request

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body sent type can be "json" / "system"

    Example: system

Create single webhook › Responses

success

  • successstring
    Example: true
  • responseobject

Get single webhook

GET
https://api.istores.co.il
/automation/webhook/{webhook_id}

Get single webhook with the data related and events

Get single webhook › path Parameters

  • webhook_idinteger · int32 · required

    Id of Webhook we look for

Get single webhook › Responses

success

  • webhook_idinteger

    The ID of the webhook used for single webhook actions

    Example: 4
  • namestring

    Webhook name to recognize

    Example: Webhook name
  • descriptionstring

    Webhook description

    Example: Webhook description
  • eventsinteger[]
  • actionstring

    Request action (post/get/put/delete)

    Example: post
  • urlstring

    Valid url for webhook

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body content type (system/custom)

    Example: system

Update single webhook

PUT
https://api.istores.co.il
/automation/webhook/{webhook_id}

Update single webhook

Update single webhook › path Parameters

  • webhook_idinteger · int32 · required

    Id of Webhook we update

Update single webhook › Request Body
optional

  • namestring

    The name of the webhook

    Example: webhook1
  • descriptionstring

    The description of the webhook

    Example: description1
  • eventsinteger[]

    Array of evnt ids (check webhook event request)

    Example: [1,2]
  • actionstring

    The action of the webhook request (post/put/delete/get)

    Example: post
  • urlstring

    The url of the webhook request

    Example: https://webhook.site/7b152643-b570-46dd-976c-bee83497af41
  • headersobject[]
  • content_typestring

    The body sent type can be "json" / "system"

    Example: system

Update single webhook › Responses

success

  • successstring
    Example: true
  • responseobject

Delete single webhook

DELETE
https://api.istores.co.il
/automation/webhook/{webhook_id}

Delete single webhook

Delete single webhook › path Parameters

  • webhook_idinteger · int32 · required

    Id of Webhook we delete

Delete single webhook › Responses

success

  • successstring
    Example: true
  • responseobject

Get list of event ids

GET
https://api.istores.co.il
/automation/webhook_events

Get list of event ids and slug explaination

Get list of event ids › Responses

  • event_idinteger

    The event id used to create/update webhooks

    Example: 1
  • event_slugstring

    The event short description formated to slug

    Example: new_order
  • event_groupstring

    The event group current slug related to (not used)

    Example: orders
shipping