meilisearch / meilisearch/meilisearch-php
[v1.17.0] Add support for webhook API
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- PHP
- Stars
- 757
- Forks
- 125
- Avg merge
- 6d 8h
- Merged PRs (30d)
- 2
Description
Description
We want to add the necessary methods in this SDK to interact with the Webhook API. This feature is introduced in Meilisearch 1.17.0, see releases.
For more context, please see:
- the usage guide
- the related issue in Meilisearch: https://github.com/meilisearch/meilisearch/issues/5792
Tasks
- Add the new methods to interact with the Meilisearch API
- Add new tests cases
- Add code samples in .code-samples.meilisearch.yaml for webhook They should perform the same action as the curl calls in Meilisearch docs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked usage guide, the related Meilisearch issue, and the existing PHP SDK API methods. Use the webhook curl calls in the linked documentation as the behavioral reference, then update .code-samples.meilisearch.yaml and add tests for the new methods. Done means webhook operations are exposed by the SDK, covered by tests, and represented by matching code samples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100